yard 0.2.3.5 → 0.4.0

data/spec/verifier_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe YARD::Verifier do
+  describe '#parse_expressions' do
+    it "should create #__execute method" do
+      v = Verifier.new("expr1")
+      v.should respond_to(:__execute)
+    end
+
+    it "should parse @tagname into tag('tagname')" do
+      obj = mock(:object)
+      obj.should_receive(:tag).with('return')
+      Verifier.new('@return').call(obj)
+    end
+
+    it "should parse @@tagname into object.tags('tagname')" do
+      obj = mock(:object)
+      obj.should_receive(:tags).with('return')
+      Verifier.new('@@return').call(obj)
+    end
+
+    it "should send any missing methods to object" do
+      obj = mock(:object)
+      obj.should_receive(:has_tag?).with('return')
+      Verifier.new('has_tag?("return")').call(obj)
+    end
+
+    it "should allow multiple expressions" do
+      obj = mock(:object)
+      obj.should_receive(:tag).with('return').and_return(true)
+      obj.should_receive(:tag).with('param').and_return(false)
+      Verifier.new('@return', '@param').call(obj).should == false
+    end
+  end
+  
+  describe '#o' do
+    it "should alias object to o" do
+      obj = mock(:object)
+      obj.should_receive(:a).ordered
+      Verifier.new('o.a').call(obj)
+    end
+  end
+
+  describe '#call' do
+    it "should mock a nonexistent tag so that exceptions are not raised" do
+      obj = mock(:object)
+      obj.should_receive(:tag).and_return(nil)
+      Verifier.new('@return.text').call(obj).should == false
+    end
+  end
+end

data/spec/yard_spec.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe YARD do
+  describe '.load_plugins' do
+    it "should load any plugin starting with 'yard_' or 'yard-'" do
+      plugins = { 
+        'yard' => mock('yard'), 
+        'yard_plugin' => mock('yard_plugin'), 
+        'yard-plugin' => mock('yard-plugin'),
+        'my-yard-plugin' => mock('yard-plugin'),
+        'rspec' => mock('rspec'),
+      }
+      plugins.each do |k, v|
+        v.should_receive(:name).at_least(1).times.and_return(k)
+      end
+      source_mock = mock(:source_index)
+      source_mock.should_receive(:entries).and_return(plugins)
+      Gem.should_receive(:source_index).and_return(source_mock)
+      YARD.should_receive(:require).with('yard_plugin').and_return(true)
+      YARD.should_receive(:require).with('yard-plugin').and_return(true)
+      log.should_receive(:debug).with(/Loading plugin 'yard_plugin'/).once
+      log.should_receive(:debug).with(/Loading plugin 'yard-plugin'/).once
+      YARD.load_plugins.should == true
+    end
+    
+    it "should ignore any plugins specified in '~/.yard/ignored_plugins'" do
+      path = File.expand_path("~/.yard/ignored_plugins")
+      plugins = { 
+        'yard-plugin' => mock('yard-plugin'),
+        'yard-plugin2' => mock('yard-plugin2'),
+        'yard-plugin3' => mock('yard-plugin3'),
+      }
+      plugins.each do |k, v|
+        v.should_receive(:name).at_least(1).times.and_return(k)
+      end
+      source_mock = mock(:source_index)
+      source_mock.should_receive(:entries).and_return(plugins)
+      File.should_receive(:file?).with(path).and_return(true)
+      IO.should_receive(:read).with(path).and_return('yard-plugin yard-plugin2')
+      Gem.should_receive(:source_index).and_return(source_mock)
+      YARD.should_receive(:require).with('yard-plugin3').and_return(true)
+      log.should_receive(:debug).with(/Loading plugin 'yard-plugin3'/).once
+      YARD.load_plugins.should == true
+    end
+  end
+end

data/templates/default/class/dot/setup.rb

@@ -0,0 +1,6 @@
+include T('default/module/dot')
+
+def init
+  super
+  sections.push :superklass
+end

data/templates/default/class/dot/superklass.erb

@@ -0,0 +1,3 @@
+<% if object.superclass.path != "Object" %>
+  <%= format_path object %> -> <%= format_path object.superclass %>;
+<% end %>

data/templates/default/class/html/constructor_details.erb

@@ -0,0 +1,8 @@
+<div id="constructor_details">
+  <h2>Constructor Details</h2>
+  <% if @ctor.namespace != object %>
+    <p class="notice">This class inherits a constructor from <%= linkify @ctor, @ctor.namespace.path %></p>
+  <% else %>
+    <%= yieldall :object => @ctor, :index => 0 %>
+  <% end %>
+</div>

data/templates/default/class/html/setup.rb

@@ -0,0 +1 @@
+include T('default/module/html')

data/templates/default/class/html/subclasses.erb

@@ -0,0 +1,4 @@
+<div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><%= @subclasses.map {|child| linkify(child) }.join(", ") %></p>
+</div>

data/templates/default/class/setup.rb

@@ -0,0 +1,29 @@
+include T('default/module')
+
+def init
+  super
+  sections.place(:subclasses).before(:children)
+  sections.delete(:children)
+  sections.place([:constructor_details, [T('method_details')]]).before(:methodmissing)
+end
+
+def constructor_details
+  ctors = object.meths(:inherited => true, :included => true)
+  return unless @ctor = ctors.find {|o| o.name == :initialize }
+  erb(:constructor_details)
+end
+
+def subclasses
+  if !defined? @@subclasses
+    @@subclasses = {}
+    list = run_verifier Registry.all(:class)
+    list.each do |o| 
+      (@@subclasses[o.superclass] ||= []) << o if o.superclass
+    end
+  end
+  
+  @subclasses = @@subclasses[object]
+  return if @subclasses.nil? || @subclasses.empty?
+  @subclasses = @subclasses.sort_by {|o| o.path }
+  erb(:subclasses)
+end

data/templates/default/class/text/setup.rb

@@ -0,0 +1,11 @@
+include T('default/module/text')
+
+def init
+  super
+  sections.place(:subclasses).before(:children)
+  sections.delete(:children)
+end
+
+def format_object_title(object)
+  "Class: #{object.path} < #{object.superclass.path}"
+end

data/templates/default/class/text/subclasses.erb

@@ -0,0 +1,5 @@
+Direct Known Subclasses:
+------------------------
+
+<%= indent(wrap(@subclasses.map {|child| linkify(child) }.join(", "))) %>
+

data/templates/default/docstring/html/abstract.erb

@@ -0,0 +1,4 @@
+<p class="note abstract">
+  <strong>This <%= object.type %> is abstract.</strong> 
+  <%= htmlify_line object.tag(:abstract).text %>
+</p>

data/templates/default/docstring/html/deprecated.erb

@@ -0,0 +1 @@
+<p class="note deprecated"><strong>Deprecated.</strong> <%= htmlify_line object.tag(:deprecated).text %></p>

data/templates/default/docstring/html/index.erb

@@ -0,0 +1,5 @@
+<div class="docstring">
+  <div class="discussion">
+    <%= yieldall %>
+  </div>
+</div>

data/templates/default/docstring/html/note.erb

@@ -0,0 +1,6 @@
+<% object.tags(:note).each do |tag| %>
+  <p class="note notetag">
+    <strong>Note:</strong> 
+    <%= htmlify_line tag.text %>
+  </p>
+<% end %>

data/templates/default/docstring/html/text.erb

@@ -0,0 +1 @@
+<%= htmlify(docstring_text) %>

data/templates/default/docstring/html/todo.erb

@@ -0,0 +1,6 @@
+<% object.tags(:todo).each do |tag| %>
+  <p class="note todo">
+    <strong>TODO:</strong> 
+    <%= htmlify_line tag.text %>
+  </p>
+<% end %>

data/templates/default/docstring/setup.rb

@@ -0,0 +1,39 @@
+def init
+  return if object.docstring.blank?
+  sections :index, [:deprecated, :abstract, :todo, :note, :text], T('tags')
+end
+
+def abstract
+  return unless object.has_tag?(:abstract)
+  erb(:abstract)
+end
+
+def deprecated
+  return unless object.has_tag?(:deprecated)
+  erb(:deprecated)
+end
+
+def todo
+  return unless object.has_tag?(:todo)
+  erb(:todo)
+end
+
+def note
+  return unless object.has_tag?(:note)
+  erb(:note)
+end
+
+def docstring_text
+  text = ""
+  if object.tags(:overload).size == 1 && object.docstring.empty?
+    text = object.tag(:overload).docstring
+  else
+    text = object.docstring
+  end
+  
+  if text.strip.empty? && object.tags(:return).size == 1 && object.tag(:return).text
+    text = object.tag(:return).text.gsub(/\A([a-z])/) {|x| x.upcase }
+  end
+  
+  text.strip
+end

data/templates/default/docstring/text/abstract.erb

@@ -0,0 +1,2 @@
+<%= indent(wrap("Abstract. #{object.tag(:abstract).text}")) %>
+

data/templates/default/docstring/text/deprecated.erb

@@ -0,0 +1,2 @@
+<%= indent(wrap("Deprecated. #{object.tag(:deprecated).text}")) %>
+

data/templates/default/docstring/text/index.erb

@@ -0,0 +1,2 @@
+
+<%= yieldall %>

data/templates/default/docstring/text/note.erb

@@ -0,0 +1,4 @@
+<% object.tags(:note).each do |tag| %>
+<%= indent(wrap("Note: #{tag.text}")) %>
+
+<% end %>

data/templates/default/docstring/text/text.erb

@@ -0,0 +1 @@
+<%= indent wrap(h(docstring_text.strip), 68) %>

data/templates/default/docstring/text/todo.erb

@@ -0,0 +1,4 @@
+<% object.tags(:todo).each do |tag| %>
+<%= indent(wrap("TODO: #{tag.text}")) %>
+
+<% end %>

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

@@ -0,0 +1 @@
+/* Override this file with custom rules */

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

@@ -0,0 +1,23 @@
+body { 
+  margin: 0;
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; 
+  font-size: 13px;
+  height: 101%;
+}
+html { overflow-y: scroll; }
+
+h1 { padding: 0; margin: 5px; margin-top: 12px; margin-left: 10px; margin-bottom: 0; font-size: 1.4em; }
+.clear { clear: both; }
+#search { position: absolute; right: 5px; top: 9px; }
+#full_list { padding: 0; list-style: none; margin-left: 0; }
+#full_list li { padding: 7px 15px; font-size: 1.1em; }
+#noresults { display: none; padding: 7px 15px; }
+li { color: #555; }
+li.deprecated { text-decoration: line-through; font-style: italic; }
+li.r1 { background: #f0f0f0; border: 1px dotted #f0f0f0; border-left-width: 0; border-right-width: 0; }
+li.r2 { background: #fafafa; border: 1px dotted #fafafa; border-left-width: 0; border-right-width: 0; }
+li:hover { background: #ffffa5; cursor: pointer; border: 1px dotted #ddddc4; border-left-width: 0; border-right-width: 0; }
+li:hover * { position: relative; left: -3px; }
+a:link, a:visited { text-decoration: none; color: #05a; }
+a:hover { background: #ffffa5; }
+#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; }

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

@@ -0,0 +1,261 @@
+body { 
+  padding: 0 20px;
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; 
+  font-size: 13px;
+}
+h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
+h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
+h1.title { margin-bottom: 10px; }
+h1.alphaindex { margin-top: 0; font-size: 22px; }
+h2 { 
+  padding: 0;
+  padding-bottom: 3px;
+  border-bottom: 1px #aaa solid;
+  font-size: 1.4em;
+  margin: 1.8em 0 0.5em;
+}
+.clear { clear: both; }
+.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
+.docstring h1 { font-size: 1.2em; }
+.docstring h2 { font-size: 1.1em; }
+.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; }
+
+.note { 
+  color: #222;
+  -moz-border-radius: 3px; -webkit-border-radius: 3px; 
+  background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px;
+}
+.note.todo { background: #ffffc5; border-color: #ececaa; }
+.note.deprecated { background: #ffe5e5; border-color: #e9dada; }
+.note.title { text-transform: lowercase; padding: 1px 5px; margin-left: 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; }
+h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
+.note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; } 
+.note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; } 
+.note.title.private { background: #d5d5d5; border-color: #c5c5c5; }
+
+h3.inherited {
+  font-style: italic;
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+  font-weight: normal;
+  padding: 0;
+  margin: 0;
+  margin-top: 12px;
+  margin-bottom: 3px;
+  font-size: 13px;
+}
+p.inherited {
+  padding: 0;
+  margin: 0;
+  margin-left: 25px;
+}
+
+dl.box {
+  width: 520px;
+  font-size: 1em;
+}
+dl.box dt {
+  float: left;
+  display: block;
+  width: 100px;
+  margin: 0;
+  text-align: right;
+  font-weight: bold;
+  border: 1px solid #aaa;
+  border-width: 1px 0px 0px 1px;
+  padding: 6px 0;
+  padding-right: 10px;
+}
+dl.box dd {
+  float: left;
+  display: block;
+  width: 380px;
+  margin: 0;
+  padding: 6px 0;
+  padding-right: 20px;
+  border: 1px solid #aaa;
+  border-width: 1px 1px 0 0;
+}
+dl.box .last {
+  border-bottom: 1px solid #aaa;
+}
+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; }
+
+#files { padding: 0; }
+#files li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
+
+dl.constants { margin-left: 40px; }
+dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
+dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
+
+.summary_desc { margin-left: 32px; display: block; font-family: sans-serif; }
+.summary_desc tt { font-size: 0.9em; }
+dl.constants .summary_desc { font-size: 0.9em; font-weight: normal; }
+
+.method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }
+.method_details.first { border: 0; }
+p.signature { 
+  font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace; 
+  padding: 6px 10px; margin-top: 18px; 
+  background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
+}
+p.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
+p.signature .overload { display: block; }
+p.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
+p.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
+p.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
+
+.tags h3 { font-size: 1em; margin-bottom: 0; }
+.tags ul { margin-top: 5px; padding-left: 30px; list-style: square; }
+.tags ul li { margin-bottom: 3px; }
+.tags ul .name { font-family: monospace; font-weight: bold; }
+.tags ul p { display: inline; margin-bottom: 5px; }
+.tags { margin-bottom: 12px; }
+
+.tags .examples h3 { margin-bottom: 10px; }
+.tags .examples h4 { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; }
+
+.tags .overload .overload_item { list-style: none; margin-bottom: 25px; }
+.tags .overload .overload_item .signature { 
+  padding: 2px 8px;
+  background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
+}
+.tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; }
+.tags .overload .docstring { margin-top: 15px; }
+
+.defines { display: none; }
+
+#method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; }
+
+.showSource { font-size: 0.9em; }
+.showSource a:link, .showSource a:visited { text-decoration: none; color: #666; }
+
+#content a:link, #content a:visited { text-decoration: none; color: #05a; }
+#content a:hover { background: #ffffa5; }
+.docstring { margin-right: 6em; }
+
+ul.summary {
+  list-style: none;
+  font-family: monospace;
+  font-size: 1em;
+  line-height: 1.5em;
+}
+ul.summary a:link, ul.summary a:visited { 
+  text-decoration: none; font-size: 1.1em;
+}
+ul.summary li { margin-bottom: 5px; }
+.summary .summary_signature { 
+  padding: 1px 10px;
+  background: #eaeaff; border: 1px solid #dfdfe5;
+  -moz-border-radius: 3px; -webkit-border-radius: 3px; 
+}
+.summary_signature:hover { background: #eeeeff; cursor: pointer; }
+#content .summary_signature:hover a:link, 
+#content .summary_signature:hover a:visited {
+  background: transparent;
+  color: #48f;
+}
+
+p.inherited a { font-family: monospace; font-size: 0.9em; }
+p.inherited { word-spacing: 5px; font-size: 1.2em; }
+
+p.children { font-size: 1.2em; }
+p.children a { font-size: 0.9em; }
+p.children strong { font-size: 0.8em; }
+p.children strong.modules { padding-left: 5px; }
+
+ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
+ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
+ul.fullTree li { text-align: center; }
+ul.fullTree li.next:before { font-size: 1.2em; content: '⬆'; color: #bbb; display: block; margin-top: 3px; }
+
+#search { position: absolute; right: 14px; top: 0px; }
+#search a:link, #search a:visited { 
+  display: block; float: left; margin-right: 4px;
+  padding: 8px 10px; text-decoration: none; color: #05a; background: #eaeaff;
+  border: 1px solid #d8d8e5;
+  -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px; 
+  -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
+}
+#search a:hover { background: #eef; color: #06b; }
+#search a.active { 
+  background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457; 
+  -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
+  -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
+}
+#search a.inactive { color: #999; }
+.inheritanceTree, .toggleDefines { float: right; }
+
+#menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
+#menu .title, #menu a { font-size: 0.7em; }
+#menu .title { color: #555; }
+#menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
+#menu a:hover { color: #05a; }
+
+#footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
+#footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; }
+#footer a:hover { color: #05a; }
+
+#listing ul.alpha { font-size: 1.1em; }
+#listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
+#listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
+#listing ul.alpha ul { margin: 0; padding: 0; }
+#listing ul small { color: #666; font-size: 0.7em; }
+
+li.r1 { background: #f0f0f0; }
+li.r2 { background: #fafafa; }
+
+#search_frame {
+  background: #fff;
+  display: none;
+  position: absolute; 
+  top: 36px; 
+  right: 18px;
+  width: 500px;
+  height: 80%;
+  overflow-y: scroll;
+  border: 1px solid #999;
+  border-collapse: collapse;
+  -webkit-box-shadow: -2px 5px 25px #aaa;
+  -moz-box-shadow: -2px 5px 25px #aaa;
+  -moz-border-radius: 2px;
+  -webkit-border-radius: 2px;
+}
+
+#content ul.summary li.deprecated a:link, 
+#content ul.summary li.deprecated a:visited { text-decoration: line-through; font-style: italic; }
+
+/* syntax highlighting */
+.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
+#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
+#filecontents pre.code, .docstring pre.code { display: block; }
+.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
+#filecontents pre.code, .docstring pre.code, 
+.tags .example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
+pre.code { color: #000; }
+pre.code .info.file { color: #555; }
+pre.code .val { color: #036A07; }
+pre.code .tstring_content,
+pre.code .heredoc_beg, pre.code .heredoc_end,
+pre.code .qwords_beg, pre.code .qwords_end,
+pre.code .tstring, pre.code .dstring { color: #036A07; }
+pre.code .fid, pre.code .id.new, pre.code .id.to_s, 
+pre.code .id.to_sym, pre.code .id.to_f, 
+pre.code .dot + pre.code .id,
+pre.code .id.to_i pre.code .id.each { color: #0085FF; }
+pre.code .comment { color: #0066FF; }
+pre.code .const, pre.code .constant { color: #585CF6; }
+pre.code .symbol { color: #C5060B; }
+pre.code .kw, 
+pre.code .label,
+pre.code .id.require, 
+pre.code .id.extend,
+pre.code .id.include { color: #0000FF; }
+pre.code .ivar { color: #318495; }
+pre.code .gvar, 
+pre.code .id.backref, 
+pre.code .id.nth_ref { color: #6D79DE; }
+pre.code .regexp, .dregexp { color: #036A07; }
+