yard 0.2.3 → 0.2.3.2

data/spec/parser/source_parser_spec.rb

@@ -5,24 +5,67 @@ describe YARD::Parser::SourceParser do
     Registry.clear
   end
   
-  it "should parse basic Ruby code" do
-    Parser::SourceParser.parse_string(<<-eof)
-      module Hello
-        class Hi
-          # Docstring
-          def me; "VALUE" end
+  describe '#parse_string' do
+    it "should parse basic Ruby code" do
+      Parser::SourceParser.parse_string(<<-eof)
+        module Hello
+          class Hi
+            # Docstring
+            # Docstring2
+            def me; "VALUE" end
+          end
         end
-      end
-    eof
-    Registry.at(:Hello).should_not == nil
-    Registry.at("Hello::Hi#me").should_not == nil
-    Registry.at("Hello::Hi#me").docstring.should == "Docstring"
+      eof
+      Registry.at(:Hello).should_not == nil
+      Registry.at("Hello::Hi#me").should_not == nil
+      Registry.at("Hello::Hi#me").docstring.should == "Docstring\nDocstring2"
+      Registry.at("Hello::Hi#me").docstring.line_range.should == (3..4)
+    end
+  end
+
+  describe '#parse' do
+    it "should parse a basic Ruby file" do
+      parse_file :example1, __FILE__
+      Registry.at(:Hello).should_not == nil
+      Registry.at("Hello::Hi#me").should_not == nil
+      Registry.at("Hello::Hi#me").docstring.should == "Docstring"
+    end
+  
+    it "should parse a set of file globs" do
+      Dir.should_receive(:[]).with('lib/**/*.rb')
+      YARD.parse('lib/**/*.rb')
+    end
+  
+    it "should parse a set of absolute paths" do
+      Dir.should_not_receive(:[])
+      IO.should_receive(:read).with('/path/to/file').and_return("")
+      YARD.parse('/path/to/file')
+    end
+
+    it "should parse files with '*' in them as globs and others as absolute paths" do
+      Dir.should_receive(:[]).with('*.rb').and_return(['a.rb', 'b.rb'])
+      IO.should_receive(:read).with('/path/to/file').and_return("")
+      IO.should_receive(:read).with('a.rb').and_return("")
+      IO.should_receive(:read).with('b.rb').and_return("")
+      YARD.parse ['/path/to/file', '*.rb']
+    end
   end
   
-  it "should parse a basic Ruby file" do
-    parse_file :example1, __FILE__
-    Registry.at(:Hello).should_not == nil
-    Registry.at("Hello::Hi#me").should_not == nil
-    Registry.at("Hello::Hi#me").docstring.should == "Docstring"
+  describe '#parse_in_order' do
+    def in_order_parse(*files)
+      paths = files.map {|f| File.join(File.dirname(__FILE__), 'examples', f.to_s + '.rb.txt') }
+      YARD::Parser::SourceParser.parse(paths, Logger::DEBUG)
+    end
+    
+    it "should attempt to parse files in order" do
+      msgs = []
+      log.should_receive(:debug) {|m| msgs << m }.at_least(:once)
+      in_order_parse 'parse_in_order_001', 'parse_in_order_002'
+      msgs[1].should =~ /Processing .+parse_in_order_001.+/
+      msgs[2].should =~ /Missing object MyModule/
+      msgs[3].should =~ /Processing .+parse_in_order_002.+/
+      msgs[4].should =~ /Re-processing .+parse_in_order_001.+/
+      msgs[5].should =~ /Object MyModule successfully resolved/
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,12 +3,10 @@ require "spec"
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'yard'))
 
-def parse_file(file, thisfile = __FILE__)
+def parse_file(file, thisfile = __FILE__, log_level = log.level)
   Registry.clear
   path = File.join(File.dirname(thisfile), 'examples', file.to_s + '.rb.txt')
-  p = YARD::Parser::SourceParser.new
-  p.parse(path)
-  p
+  YARD::Parser::SourceParser.parse(path, log_level)
 end
 
 def described_in_docs(klass, meth, file = nil)

data/spec/tags/library_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe YARD::Tags::Library do
+  def tag(docstring)
+    Docstring.new(docstring).tags.first
+  end
+  
+  describe '#see_tag' do
+    it "should take a URL" do
+      tag("@see http://example.com").name.should == "http://example.com"
+    end
+    
+    it "should take an object path" do
+      tag("@see String#reverse").name.should == "String#reverse"
+    end
+    
+    it "should take a description after the url/object" do
+      tag = tag("@see http://example.com An Example Site")
+      tag.name.should == "http://example.com"
+      tag.text.should == "An Example Site"
+    end
+  end
+end

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

@@ -1,4 +1,6 @@
-<p class="section <%= generator_name %>">
-  <strong>Deprecated.</strong> <em><%= htmlify object.tag(:deprecated).text %></em>
-</p>
+<div class="section <%= generator_name %>">
+  <p>
+    <strong>Deprecated.</strong> <em><%= htmlify(object.tag(:deprecated).text).gsub(/<\/?p>/, '') %></em>
+  </p>
+</div>
 

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

@@ -11,7 +11,7 @@
       <h1>Method List</h1>
       <ul>
       <% for obj in objects %>
-        <li nowrap="nowrap">
+        <li nowrap="nowrap" class="<%= 'deprecated' if obj.has_tag?(:deprecated) %>">
           <%= linkify(obj, (obj.scope == :class ? '' : '#') + obj.name.to_s, nil, false) %> 
           <% if obj.namespace == Registry.root %>
             <em>(Global method)</em>

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

@@ -14,7 +14,7 @@
         <li><%= linkify(root, "Top Level Namespace", nil, false) %></li>
       <% end %>
       <% for obj in objects %>
-        <li><%= linkify(obj) %> <em>(<%= obj.type %>)</em></li>
+        <li class="<%= 'deprecated' if obj.has_tag?(:deprecated) %>"><%= linkify(obj) %> <em>(<%= obj.type %>)</em></li>
       <% end %>
       </ul>
     </div>

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

@@ -0,0 +1 @@
+/* Override this stylesheet in your templates directory with any extra declarations */

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

@@ -11,5 +11,6 @@
         <%= htmlify @contents, markup_for(filename) %>
       </div>
     </div>
+    <%= render :footer %>
   </body>
 </html>

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

@@ -0,0 +1,5 @@
+<div id="yard_info">
+  Generated on <%= Time.now.strftime("%A, %B %d %Y at %r") %> by 
+  <abbr class="yard" title="Yay! A Ruby Documentation Tool"><a href="http://yard.soen.ca">YARD</a></abbr> 
+  <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
+</div>

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

@@ -11,5 +11,6 @@
     <div id="content">
       <%= yield object %>
     </div>
+    <%= render :footer %>
   </body>
 </html>

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

@@ -1,3 +1,4 @@
 <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
 <link rel="stylesheet" href="<%= url_for(css_file) %>" type="text/css" charset="utf-8" />
+<link rel="stylesheet" href="<%= url_for(css_custom_file) %>" type="text/css" charset="utf-8" />
 <link rel="stylesheet" href="<%= url_for(css_syntax_file) %>" type="text/css" charset="utf-8" />

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

@@ -3,7 +3,7 @@
 <html>
   <head>
     <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-    <title>YARD Documentation</title>
+    <title><%= options[:title] || "YARD Documentation" %></title>
   </head>
   <frameset cols="20%,*">
     <frameset rows="13%,45%,42%">

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

@@ -1,6 +1,7 @@
 body { font-family: Myriad, Helvetica, Arial, Verdana, sans-serif; font-size: 10pt; }
 #nav ul { list-style: none; padding: 0; margin: 0; }
 #nav ul li { white-space: nowrap; }
+#nav ul li.deprecated a { text-decoration: line-through; font-style: italic; }
 #nav li em { font-size: 0.9em; color: #999; }
 #nav h1 { font-size: 1.2em; }
 h1 { font-size: 1.5em; background: #eee; color: #000; padding: 3px; text-decoration: none; }
@@ -20,6 +21,7 @@ h3 { font-size: 1.0em; }
 .section.tags,.section.docstring,.section.source { padding: 5px 12px; }
 .section.method .details_title { font-size: 1.1em; background: #dde; padding: 7px; }
 .overload .section.method .details_title { background: #e2e2ea; }
+.overload .section.source { display: none; }
 .section.method .details_title p.aliases { padding: 0; margin: 0; font-style: italic; font-size: 0.9em; }
 .section.method .details_title p.aliases tt { font-weight: bold; font-style: normal; font-size: 1.1em; }
 .section.constants dl { font-family: monospace; }
@@ -43,6 +45,7 @@ h3 { font-size: 1.0em; }
 .section.attributes .docstring { width: 80%; }
 .section.attributes .docstring * { display: inline; }
 .section.attributes tr.hasaliases td, .section.attributes tr.hasaliases th { padding-bottom: 0; }
+.section.deprecated { margin-left: 15px; }
 .section.inheritance { background: #ddd; padding: 5px; border: 1px solid #ccc; border-top: 0; }
 .section.inheritance ul { list-style: none; padding-left: 2.2em; margin: 0; }
 .section.inheritance ul li { line-height: 1.2em; }
@@ -73,3 +76,6 @@ h3 { font-size: 1.0em; }
 .included div, .inherited div { color: #444; margin: 1.5em 0; width: 47%; border: 1px solid #ccc; float: left; margin-right: 12px; }
 .included p .name, .inherited p .name { font-family: monospace; }
 .included p, .inherited p { margin: 5px; }
+#yard_info a:link, #yard_info a:visited { color: #333; }
+#yard_info { margin-top: 12px; margin-bottom: 7px; text-align: center; color: #444; background: #ddd; padding: 8px; border: 1px solid #ccc; font-size: 0.8em; }
+#yard_info .yard { font-weight: bold; }

data/templates/default/tags/html/see.erb

@@ -5,7 +5,7 @@
     <dt></dt>
     <dd>
       <span class='desc'>
-        <%= object.tags(:see).map {|t| "<tt>" + linkify(t.text, t.text) + "</tt>" }.join(", ") %>
+        <%= object.tags(:see).map {|t| "<tt>" + linkify(t.name, t.text || t.name) + "</tt>" }.join(", ") %>
       </span>
     </dd>
   </dl>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yard
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.3.2
 platform: ruby
 authors: 
 - Loren Segal
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-07 00:00:00 -04:00
+date: 2009-07-06 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: 
+description: "    YARD is a documentation generation tool for the Ruby programming language.\n    It enables the user to generate consistent, usable documentation that can be\n    exported to a number of formats very easily, and also supports extending for\n    custom Ruby constructs such as custom class level definitions.\n"
 email: lsegal@soen.ca
 executables: 
 - yardoc
@@ -43,6 +43,7 @@ files:
 - bin/yard-graph
 - bin/yardoc
 - bin/yri
+- lib/rubygems_plugin.rb
 - lib/yard/autoload.rb
 - lib/yard/cli/yard_graph.rb
 - lib/yard/cli/yardoc.rb
@@ -202,10 +203,13 @@ files:
 - spec/handlers/visibility_handler_spec.rb
 - spec/handlers/yield_handler_spec.rb
 - spec/parser/examples/example1.rb.txt
+- spec/parser/examples/parse_in_order_001.rb.txt
+- spec/parser/examples/parse_in_order_002.rb.txt
 - spec/parser/examples/tag_handler_001.rb.txt
 - spec/parser/ruby/ast_node_spec.rb
 - spec/parser/ruby/legacy/statement_list_spec.rb
 - spec/parser/ruby/legacy/token_list_spec.rb
+- spec/parser/ruby/ruby_parser_spec.rb
 - spec/parser/source_parser_spec.rb
 - spec/parser/tag_parsing_spec.rb
 - spec/rake/yardoc_task_spec.rb
@@ -215,6 +219,7 @@ files:
 - spec/spec_helper.rb
 - spec/tags/default_factory_spec.rb
 - spec/tags/default_tag_spec.rb
+- spec/tags/library_spec.rb
 - spec/tags/overload_tag_spec.rb
 - spec/tags/ref_tag_list_spec.rb
 - templates/default/attributes/html/header.erb
@@ -233,7 +238,9 @@ files:
 - templates/default/fulldoc/html/all_methods.erb
 - templates/default/fulldoc/html/all_namespaces.erb
 - templates/default/fulldoc/html/app.js
+- templates/default/fulldoc/html/custom.css
 - templates/default/fulldoc/html/file.erb
+- templates/default/fulldoc/html/footer.erb
 - templates/default/fulldoc/html/header.erb
 - templates/default/fulldoc/html/html_head.erb
 - templates/default/fulldoc/html/index.erb
@@ -339,7 +346,8 @@ files:
 - LICENSE
 - README.markdown
 - Rakefile
-has_rdoc: false
+- .yardopts
+has_rdoc: yard
 homepage: http://yard.soen.ca
 licenses: []
 
@@ -363,7 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yard
-rubygems_version: 1.3.2
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: Documentation tool for consistent and usable documentation in Ruby.