yard 0.6.1 → 0.6.2

data/spec/parser/ruby/legacy/statement_list_spec.rb

@@ -270,4 +270,15 @@ eof
     s[1].tokens.to_s.should == "else"
     s[1].block.to_s.should == "bar"
   end
+  
+  it "should allow aliasing keywords" do
+    ['do x', 'x do', 'end begin', 'begin end'].each do |a|
+      s = stmt("alias #{a}\ndef foo; end")
+      s.tokens.to_s.should == "alias #{a}"
+      s.block.should be_nil
+    end
+    
+    s = stmt("alias do x if 2 ==\n 2")
+    s.tokens.to_s.should == "alias do x if 2 ==\n 2"
+  end
 end

data/spec/parser/source_parser_spec.rb

@@ -204,6 +204,38 @@ describe YARD::Parser::SourceParser do
       File.should_not_receive(:read_binary)
       YARD.parse(["foo/bar", "foo/baz"], ["foo", /baz$/])
     end
+    
+    it "should convert file contents to proper encoding if coding line is present" do
+      valid = []
+      valid << "# encoding: sjis"
+      valid << "# xxxxxencoding: sjis"
+      valid << "# xxxxxencoding: sjis xxxxxx"
+      valid << "# ENCODING: sjis"
+      valid << "#coDiNG: sjis"
+      valid << "# -*- coding: sjis -*-"
+      valid << "### coding: sjis"
+      valid << "# encoding=sjis"
+      valid << "# encoding:sjis"
+      valid << "# encoding   =   sjis"
+      valid << "# encoding   ==   sjis"
+      valid << "# encoding :  sjis"
+      valid << "# encoding ::  sjis"
+      valid << "#!/bin/shebang\n# encoding: sjis"
+      valid << "#!/bin/shebang\r\n# coding: sjis"
+      invalid = []
+      invalid << "#\n# encoding: sjis"
+      invalid << "#!/bin/shebang\n#\n# encoding: sjis"
+      invalid << "# !/bin/shebang\n# encoding: sjis"
+      {:should => valid, :should_not => invalid}.each do |msg, list|
+        list.each do |src|
+          Registry.clear
+          parser = Parser::SourceParser.new
+          File.should_receive(:read_binary).with('tmpfile').and_return(src)
+          result = parser.parse("tmpfile")
+          result.enumerator[0].source.encoding.to_s.send(msg) == 'Shift_JIS'
+        end
+      end
+    end if RUBY19
   end
   
   describe '#parse_in_order' do
@@ -220,7 +252,7 @@ describe YARD::Parser::SourceParser do
       msgs[2].should =~ /Missing object MyModule/
       msgs[3].should =~ /Processing .+parse_in_order_002.+/
       msgs[4].should =~ /Re-processing .+parse_in_order_001.+/
-    end
+    end if CONTINUATIONS_SUPPORTED
     
     it "should attempt to order files by length (process toplevel files first)" do
       %w(a a/b a/b/c).each do |file|

data/spec/server/commands/static_file_command_spec.rb

@@ -17,23 +17,40 @@ describe YARD::Server::Commands::StaticFileCommand do
     
     it "should search through document root before static paths" do
       File.should_receive(:exist?).with('/c/path/to/file.txt').ordered.and_return(false)
-      StaticFileCommand::STATIC_PATHS.each do |path|
+      StaticFileCommand::STATIC_PATHS.reverse.each do |path|
         File.should_receive(:exist?).with(File.join(path, 'path/to/file.txt')).ordered.and_return(false)
       end
       run '/path/to/file.txt'
     end
     
     it "should return file contents if found" do
-      path = File.join(StaticFileCommand::STATIC_PATHS[0], '/path/to/file.txt')
+      path = File.join(StaticFileCommand::STATIC_PATHS.last, '/path/to/file.txt')
       File.should_receive(:exist?).with('/c/path/to/file.txt').and_return(false)
       File.should_receive(:exist?).with(path).and_return(true)
       File.should_receive(:read).with(path).and_return('FOO')
       run('/path/to/file.txt', 200, 'FOO')
     end
     
+    it "should allow registering of new paths and use those before other static paths" do
+      Server.register_static_path '/foo'
+      path = '/foo/path/to/file.txt'
+      File.should_receive(:exist?).with('/c/path/to/file.txt').and_return(false)
+      File.should_receive(:exist?).with(path).and_return(true)
+      File.should_receive(:read).with(path).and_return('FOO')
+      run('/path/to/file.txt', 200, 'FOO')
+    end
+
+    it "should not use registered path before docroot" do
+      Server.register_static_path '/foo'
+      path = '/foo/path/to/file.txt'
+      File.should_receive(:exist?).with('/c/path/to/file.txt').and_return(true)
+      File.should_receive(:read).with('/c/path/to/file.txt').and_return('FOO')
+      run('/c/path/to/file.txt', 200, 'FOO')
+    end
+    
     it "should return 404 if not found" do
       File.should_receive(:exist?).with('/c/path/to/file.txt').ordered.and_return(false)
-      StaticFileCommand::STATIC_PATHS.each do |path|
+      StaticFileCommand::STATIC_PATHS.reverse.each do |path|
         File.should_receive(:exist?).with(File.join(path, 'path/to/file.txt')).ordered.and_return(false)
       end
       run('/path/to/file.txt', 404)

data/spec/server_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe YARD::Server do
+  describe '.register_static_path' do
+    it "should register a static path" do
+      YARD::Server.register_static_path 'foo'
+      YARD::Server::Commands::StaticFileCommand::STATIC_PATHS.last.should == "foo"
+    end
+  end
+end

data/spec/templates/examples/method001.html

@@ -33,7 +33,7 @@ Comments
   
     <li>
       
-        <span class='type'>(<tt>String</tt>)</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
       
       
         <span class='name'>x</span>
@@ -46,6 +46,36 @@ Comments
     </li>
   
 </ul>
+
+  
+    
+    
+    <h3>Options Hash (<tt>x</tt>):</h3>
+    <ul class="option">
+      
+        <li>
+          <span class="type">(<tt>String</tt>)</span>
+          <span class="name">:key1</span>
+          <span class="default">
+            
+              &mdash; default:
+              <tt>default</tt>
+            
+          </span>
+          &mdash; <div class='inline'>first key</div>
+        </tr>
+      
+        <li>
+          <span class="type">(<tt>Symbol</tt>)</span>
+          <span class="name">:key2</span>
+          <span class="default">
+            
+          </span>
+          &mdash; <div class='inline'>second key</div>
+        </tr>
+      
+    </ul>
+  
 <h3>Returns:</h3>
 <ul class="return">
   
@@ -85,10 +115,10 @@ Comments
       <pre class="lines">
 
 
-7</pre>
+9</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 7</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 9</span>
 
 def m(x) end</pre>
     </td>

data/spec/templates/examples/method001.txt

@@ -12,7 +12,14 @@
 Parameters:
 -----------
 
-    (String) x - the x argument
+    (Hash) x - the x argument
+
+Options Hash (x):
+-----------------
+
+    (String) :key1 - default: default - first key
+
+    (Symbol) :key2 - second key
 
 Returns:
 --------

data/spec/templates/helpers/markup_helper_spec.rb

@@ -12,37 +12,25 @@ end
 describe YARD::Templates::Helpers::MarkupHelper do
   describe '#load_markup_provider' do
     before do
+      log.stub!(:error)
       @gen = mock('Generator')
       @gen.extend(YARD::Templates::Helpers::MarkupHelper)
     end
   
-    def generator_should_exit
-      STDERR.should_receive(:puts)
-      @gen.should_receive(:exit)
-    end
-  
     it "should exit on an invalid markup type" do
-      generator_should_exit
       @gen.stub!(:options).and_return({:markup => :invalid})
-    
-      # it will raise since providers == nil
-      # but in reality it would have already `exit`ed.
-      @gen.load_markup_provider rescue nil 
+      @gen.load_markup_provider.should == false
     end
 
-    it "should exit on when an invalid markup provider is specified" do
-      generator_should_exit
+    it "should fail on when an invalid markup provider is specified" do
       @gen.stub!(:options).and_return({:markup => :markdown, :markup_provider => :invalid})
-    
-      # it will raise since providers == nil
-      # but in reality it would have already `exit`ed.
-      @gen.load_markup_provider rescue nil
+      @gen.load_markup_provider.should == false
       @gen.markup_class.should == nil
     end
   
     it "should load nothing if rdoc is specified" do
       @gen.stub!(:options).and_return({:markup => :rdoc})
-      @gen.load_markup_provider
+      @gen.load_markup_provider.should == true
       @gen.markup_class.should == YARD::Templates::Helpers::MarkupHelper::SimpleMarkup
     end
   
@@ -52,44 +40,51 @@ describe YARD::Templates::Helpers::MarkupHelper do
       # this only raises an exception because we mock out require to avoid 
       # loading any libraries but our implementation tries to return the library 
       # name as a constant
-      @gen.load_markup_provider rescue nil
+      @gen.load_markup_provider.should rescue nil
       @gen.markup_provider.should == :bluecloth
     end
   
     it "should continue searching if some of the providers are unavailable" do
       @gen.should_receive(:require).with('bluecloth').and_raise(LoadError)
       @gen.should_receive(:require).with('maruku').and_raise(LoadError)
-      @gen.should_receive(:require).with('rpeg-markdown').and_return(true)
+      @gen.should_receive(:require).with('rpeg-markdown').and_raise(LoadError)
+      @gen.should_receive(:require).with('rdiscount').and_raise(LoadError)
+      @gen.should_receive(:require).with('kramdown').and_return(true)
       @gen.stub!(:options).and_return({:markup => :markdown})
       # this only raises an exception because we mock out require to avoid 
       # loading any libraries but our implementation tries to return the library 
       # name as a constant
-      @gen.load_markup_provider rescue nil
-      @gen.markup_provider.should == :"rpeg-markdown"
+      @gen.load_markup_provider.should rescue nil
+      @gen.markup_provider.should == :"kramdown"
     end
   
     it "should override the search if `:markup_provider` is set in options" do
       @gen.should_receive(:require).with('rdiscount').and_return(true)
       @gen.stub!(:options).and_return({:markup => :markdown, :markup_provider => :rdiscount})
-      @gen.load_markup_provider rescue nil
+      @gen.load_markup_provider.should rescue nil
       @gen.markup_provider.should == :rdiscount
     end
 
     it "should fail if no provider is found" do
-      generator_should_exit
       YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:markdown].each do |p|
         @gen.should_receive(:require).with(p[:lib].to_s).and_raise(LoadError)
       end
       @gen.stub!(:options).and_return({:markup => :markdown})
-      @gen.load_markup_provider rescue nil
+      @gen.load_markup_provider.should == false
       @gen.markup_provider.should == nil
     end
 
     it "should fail if overridden provider is not found" do
-      generator_should_exit
       @gen.should_receive(:require).with('rdiscount').and_raise(LoadError)
       @gen.stub!(:options).and_return({:markup => :markdown, :markup_provider => :rdiscount})
-      @gen.load_markup_provider rescue nil
+      @gen.load_markup_provider.should == false
+      @gen.markup_provider.should == nil
+    end
+    
+    it "should fail if the markup type is not found" do
+      log.should_receive(:error).with(/Invalid markup/)
+      @gen.stub!(:options).and_return(:markup => :xxx)
+      @gen.load_markup_provider.should == false
       @gen.markup_provider.should == nil
     end
   end

data/spec/templates/method_spec.rb

@@ -22,7 +22,9 @@ describe YARD::Templates::Engine.template(:default, :method) do
       YARD.parse_string <<-'eof'
         private
         # Comments
-        # @param [String] x the x argument
+        # @param [Hash] x the x argument
+        # @option x [String] :key1 (default) first key
+        # @option x [Symbol] :key2 second key
         # @return [String] the result
         # @raise [Exception] hi!
         # @deprecated for great justice

data/spec/verifier_spec.rb

@@ -51,6 +51,11 @@ describe YARD::Verifier do
     it "should not fail if no expressions were added" do
       lambda { Verifier.new.call(nil) }.should_not raise_error
     end
+    
+    it "should always ignore proxy objects and return true" do
+      v = Verifier.new('tag(:x)')
+      lambda { v.call(P('foo')).should == true }.should_not raise_error
+    end
   end
   
   describe '#expressions' do

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

@@ -35,12 +35,15 @@ h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right;
 .note.returns_void { background: #efefef; }
 .note.deprecated { background: #ffe5e5; border-color: #e9dada; }
 .note.private { background: #ffffc5; border-color: #ececaa; }
-.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; display: inline; }
+.note.title { text-transform: lowercase; padding: 1px 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; }
+.summary_signature + .note.title { margin-left: 7px; }
 h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
 .note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; } 
 .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; }
+.discussion .note { margin-top: 6px; }
+.discussion .note:first-child { margin-top: 0; }
 
 h3.inherited {
   font-style: italic;

data/templates/default/fulldoc/html/js/app.js

@@ -152,7 +152,7 @@ function generateTOC() {
     show = true;
     var thisTag = parseInt(this.tagName[1]);
     if (this.id.length == 0) {
-      var proposedId = $(this).text().replace(/[^a-z0-9:'"\.()=-]/ig, '_');
+      var proposedId = $(this).text().replace(/[^a-z0-9:\.()=-]/ig, '_');
       if ($('#' + proposedId).length > 0) proposedId += counter++;
       this.id = proposedId;
     }

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

@@ -12,11 +12,9 @@
             <% if tag.pair.defaults %>
               &mdash; default:
               <%= tag.pair.defaults.map {|t| "<tt>#{h t}</tt>" }.join(", ") %>
-            <% else %>
-              <span class="na">N/A</span>
             <% end %>
           </span>
-          <%= "&mdash;" + htmlify_line(tag.pair.text) if tag.pair.text %>
+          <%= "&mdash; " + htmlify_line(tag.pair.text) if tag.pair.text %>
         </tr>
       <% end %>
     </ul>

data/templates/default/tags/setup.rb

@@ -10,13 +10,14 @@ def return
     return if object.name == :initialize && object.scope == :instance
     return if object.tags(:return).size == 1 && object.tag(:return).types == ['void']
   end
-  tag :return, :no_names => true
+  tag(:return)
 end
 
 private
 
-def tag(name, opts = {})
+def tag(name, opts = nil)
   return unless object.has_tag?(name)
+  opts ||= options_for_tag(name)
   @no_names = true if opts[:no_names]
   @no_types = true if opts[:no_types]
   @name = name
@@ -29,19 +30,21 @@ def create_tag_methods(tags)
   tags.each do |tag|
     next if respond_to?(tag)
     instance_eval(<<-eof, __FILE__, __LINE__ + 1)
-      def #{tag}
-        opts = {:no_types => true, :no_names => true}
-        case Tags::Library.factory_method_for(#{tag.inspect})
-        when :with_types
-          opts[:no_types] = false
-        when :with_types_and_name
-          opts[:no_types] = false
-          opts[:no_names] = false
-        when :with_name
-          opts[:no_names] = false
-        end
-        tag #{tag.inspect}, opts
-      end
+      def #{tag}; tag(#{tag.inspect}) end
     eof
   end
 end
+
+def options_for_tag(tag)
+  opts = {:no_types => true, :no_names => true}
+  case Tags::Library.factory_method_for(tag)
+  when :with_types
+    opts[:no_types] = false
+  when :with_types_and_name
+    opts[:no_types] = false
+    opts[:no_names] = false
+  when :with_name
+    opts[:no_names] = false
+  end
+  opts
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 1
-  version: 0.6.1
+  - 2
+  version: 0.6.2
 platform: ruby
 authors: 
 - Loren Segal
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-06 00:00:00 -04:00
+date: 2010-11-15 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -52,6 +52,7 @@ files:
 - lib/yard/autoload.rb
 - lib/yard/cli/command.rb
 - lib/yard/cli/command_parser.rb
+- lib/yard/cli/config.rb
 - lib/yard/cli/diff.rb
 - lib/yard/cli/gems.rb
 - lib/yard/cli/graph.rb
@@ -70,6 +71,7 @@ files:
 - lib/yard/code_objects/namespace_object.rb
 - lib/yard/code_objects/proxy.rb
 - lib/yard/code_objects/root_object.rb
+- lib/yard/config.rb
 - lib/yard/core_ext/array.rb
 - lib/yard/core_ext/file.rb
 - lib/yard/core_ext/hash.rb
@@ -168,6 +170,7 @@ files:
 - lib/yard/server/templates/doc_server/search/html/search.erb
 - lib/yard/server/templates/doc_server/search/html/setup.rb
 - lib/yard/server/webrick_adapter.rb
+- lib/yard/server.rb
 - lib/yard/tags/default_factory.rb
 - lib/yard/tags/default_tag.rb
 - lib/yard/tags/library.rb
@@ -194,7 +197,9 @@ files:
 - lib/yard/verifier.rb
 - lib/yard.rb
 - spec/cli/command_parser_spec.rb
+- spec/cli/config_spec.rb
 - spec/cli/diff_spec.rb
+- spec/cli/gems_spec.rb
 - spec/cli/help_spec.rb
 - spec/cli/server_spec.rb
 - spec/cli/stats_spec.rb
@@ -209,6 +214,7 @@ files:
 - spec/code_objects/namespace_object_spec.rb
 - spec/code_objects/proxy_spec.rb
 - spec/code_objects/spec_helper.rb
+- spec/config_spec.rb
 - spec/core_ext/array_spec.rb
 - spec/core_ext/file_spec.rb
 - spec/core_ext/hash_spec.rb
@@ -257,6 +263,7 @@ files:
 - spec/parser/c_parser_spec.rb
 - spec/parser/examples/array.c.txt
 - spec/parser/examples/example1.rb.txt
+- spec/parser/examples/override.c.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
@@ -286,6 +293,7 @@ files:
 - spec/server/spec_helper.rb
 - spec/server/static_caching_spec.rb
 - spec/server/webrick_servlet_spec.rb
+- spec/server_spec.rb
 - spec/spec_helper.rb
 - spec/tags/default_factory_spec.rb
 - spec/tags/default_tag_spec.rb
@@ -330,7 +338,6 @@ files:
 - spec/templates/tag_spec.rb
 - spec/templates/template_spec.rb
 - spec/verifier_spec.rb
-- spec/yard_spec.rb
 - templates/default/class/dot/setup.rb
 - templates/default/class/dot/superklass.erb
 - templates/default/class/html/constructor_details.erb