yard 0.9.24 → 0.9.25

data/spec/templates/engine_spec.rb

@@ -1,131 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-RSpec.describe YARD::Templates::Engine do
-  before { @paths = Engine.template_paths }
-  after { Engine.template_paths = @paths }
-
-  describe ".register_template_path" do
-    it "registers a String path" do
-      Engine.register_template_path('.')
-      expect(Engine.template_paths.pop).to eq '.'
-    end
-
-    it "does not duplicate paths" do
-      Engine.template_paths = []
-      Engine.register_template_path('foo')
-      Engine.register_template_path('foo')
-      expect(Engine.template_paths).to eq ['foo']
-    end
-  end
-
-  describe ".template!" do
-    it "creates a module including Template" do
-      mod = Engine.template!('path/to/template')
-      expect(mod).to include(Template)
-      expect(mod.full_path.to_s).to eq 'path/to/template'
-    end
-
-    it "creates a module including Template with full_path" do
-      mod = Engine.template!('path/to/template2', '/full/path/to/template2')
-      expect(mod).to include(Template)
-      expect(mod.full_path.to_s).to eq '/full/path/to/template2'
-    end
-  end
-
-  describe ".template" do
-    it "raises an error if the template is not found" do
-      expect { Engine.template(:a, :b, :c) }.to raise_error(ArgumentError)
-    end
-
-    it "creates a module including Template" do
-      mock = double(:template)
-      expect(Engine).to receive(:find_template_paths).with(nil, 'template/name').and_return(['/full/path/template/name'])
-      expect(Engine).to receive(:template!).with('template/name', ['/full/path/template/name']).and_return(mock)
-      expect(Engine.template('template/name')).to eq mock
-    end
-
-    it "creates a Template from a relative Template path" do
-      expect(Engine).to receive(:template_paths).and_return([])
-      expect(File).to receive(:directory?).with("/full/path/template/notname").and_return(true)
-      start_template = double(:start_template,
-        :full_path  => '/full/path/template/name',
-        :full_paths => ['/full/path/template/name'])
-      expect(start_template).to receive(:is_a?).with(Template).and_return(true)
-      mod = Engine.template(start_template, '..', 'notname')
-      expect(mod).to include(Template)
-      expect(mod.full_path.to_s).to eq "/full/path/template/notname"
-    end
-
-    it "creates a Template including other matching templates in path" do
-      paths = ['/full/path/template/name', '/full/path2/template/name']
-      expect(Engine).to receive(:find_template_paths).with(nil, 'template').at_least(1).times.and_return([])
-      expect(Engine).to receive(:find_template_paths).with(nil, 'template/name').and_return(paths)
-      ancestors = Engine.template('template/name').ancestors.map(&:class_name)
-      expect(ancestors).to include("Template__full_path2_template_name")
-    end
-
-    it "includes parent directories before other template paths" do
-      paths = ['/full/path/template/name', '/full/path2/template/name']
-      expect(Engine).to receive(:find_template_paths).with(nil, 'template/name').and_return(paths)
-      ancestors = Engine.template('template/name').ancestors.map(&:class_name)
-      expect(ancestors[0, 4]).to eq ["Template__full_path_template_name", "Template__full_path_template",
-        "Template__full_path2_template_name", "Template__full_path2_template"]
-    end
-  end
-
-  describe ".generate" do
-    it "generates with fulldoc template" do
-      mod = double(:template)
-      options = TemplateOptions.new
-      options.reset_defaults
-      options.objects = [:a, :b, :c]
-      options.object = Registry.root
-      expect(mod).to receive(:run).with(options)
-      expect(Engine).to receive(:template).with(:default, :fulldoc, :text).and_return(mod)
-      Engine.generate([:a, :b, :c])
-    end
-  end
-
-  describe ".render" do
-    def loads_template(*args)
-      expect(Engine).to receive(:template).with(*args).and_return(@template)
-    end
-
-    before(:all) do
-      @object = CodeObjects::MethodObject.new(:root, :method)
-    end
-
-    before do
-      @options = TemplateOptions.new
-      @options.reset_defaults
-      @options.object = @object
-      @options.type = @object.type
-      @template = double(:template, :include => nil)
-      expect(@template).to receive(:run).with(@options)
-    end
-
-    it "accepts method call with no parameters" do
-      loads_template(:default, :method, :text)
-      @object.format
-    end
-
-    it "allows template key to be changed" do
-      loads_template(:javadoc, :method, :text)
-      @options.template = :javadoc
-      @object.format(:template => :javadoc)
-    end
-
-    it "allows type key to be changed" do
-      loads_template(:default, :fulldoc, :text)
-      @options.type = :fulldoc
-      @object.format(:type => :fulldoc)
-    end
-
-    it "allows format key to be changed" do
-      loads_template(:default, :method, :html)
-      @options.format = :html
-      @object.format(:format => :html)
-    end
-  end
-end

data/spec/templates/examples/class001.html

@@ -1,308 +0,0 @@
-<h1>Class: A
-  <span class="abstract note title">Abstract</span>
-  
-  
-</h1>
-<div class="box_info">
-  
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName">B</span>
-      
-        <ul class="fullTree">
-          <li>Object</li>
-          
-            <li class="next">B</li>
-          
-            <li class="next">A</li>
-          
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      
-    </dd>
-  </dl>
-  
-
-  
-  
-  
-  
-  
-
-  
-
-  
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>(stdin)</dd>
-  </dl>
-  
-</div>
-
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <div class="note abstract">
-  <strong>This class is abstract.</strong>
-  <div class='inline'>override this class</div>
-</div>
-Comments
-
-  </div>
-</div>
-<div class="tags">
-  
-
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-    
-      <li>A</li>
-    
-      <li><a href="http://example.com" target="_parent" title="Example">Example</a></li>
-    
-  </ul>
-<p class="tag_title">Author:</p>
-<ul class="author">
-  
-    <li>
-      
-      
-      
-      
-        
-        <div class='inline'>Test</div>
-      
-    </li>
-  
-</ul>
-<p class="tag_title">Version:</p>
-<ul class="version">
-  
-    <li>
-      
-      
-      
-      
-        
-        <div class='inline'>1.0</div>
-      
-    </li>
-  
-</ul>
-
-</div><div id="subclasses">
-  <h2>Direct Known Subclasses</h2>
-  <p class="children">C</p>
-</div>
-
-
-
-
-
-
-
-  
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-
-    <ul class="summary">
-      
-        <li class="public deprecated">
-  <span class="summary_signature">
-    
-      <a  title="#a (instance method)">#<strong>a</strong>  </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  <span class="deprecated note title">deprecated</span>
-  
-
-  
-    <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'></div></span>
-  
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a  title="#initialize (instance method)">#<strong>initialize</strong>(test)  &#x21d2; A </a>
-    
-
-    
-  </span>
-  
-  
-    <span class="note title constructor">constructor</span>
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>constructor method!.</div></span>
-  
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a  title="#method_missing (instance method)">#<strong>method_missing</strong>(*args)  </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>HI.</div></span>
-  
-</li>
-
-      
-    </ul>
-  
-
-
-  <div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-  
-    <div class="method_details first">
-  <h3 class="signature first" id="initialize-instance_method">
-  
-    #<strong>initialize</strong>(test)  &#x21d2; <tt>A</tt> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    constructor method!
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-15</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 15</span>
-
-def initialize(test) end</pre>
-    </td>
-  </tr>
-</table>
-</div>
-  
-</div>
-<div id="method_missing_details" class="method_details_list">
-  <h2>Dynamic Method Handling</h2>
-  <p class="notice this">
-    This class handles dynamic methods through the <tt>method_missing</tt> method
-    
-  </p>
-  
-    <div class="method_details first">
-  <h3 class="signature first" id="method_missing-instance_method">
-  
-    #<strong>method_missing</strong>(*args)  
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    HI
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-10</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 10</span>
-
-def method_missing(*args) 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">
-  <h3 class="signature first" id="a-instance_method">
-  
-    #<strong>a</strong>  
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'></div></div>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div><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/class001.txt

@@ -1,36 +0,0 @@
------------------------------------------------------------ Class: A < B
-
-    Abstract. override this class
-
-    Comments 
-
-See Also:
----------
-
-    - A
-    - http://example.com - Example
-
-Author:
--------
-
-    Test
-
-Version:
---------
-
-    1.0
-
-
-------------------------------------------------------------------------
-
-Direct Known Subclasses:
-------------------------
-
-    C
-
-Instance methods:
------------------
-
-    a, initialize, method_missing
-
-