yard 0.7.1 → 0.7.2

data/spec/handlers/method_handler_spec.rb

@@ -166,4 +166,12 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MethodHandler"
     log.should_receive(:warn).with(/Invalid.+macro name.+Foo\.foo/)
     YARD.parse_string "class Foo\n# @macro\ndef self.foo; end\nend"
   end
+  
+  it "should handle 'def end' methods" do
+    obj = Registry.at('F::A#foo')
+    obj.should_not be_nil
+    obj = Registry.at('F::A#bar')
+    obj.should_not be_nil
+    obj.docstring.should == 'PASS'
+  end
 end

data/spec/parser/base_spec.rb

@@ -5,7 +5,8 @@ describe YARD::Parser::Base do
     class MyParser < Parser::Base; def initialize(a, b) end end
     
     it "should take 2 arguments" do
-      lambda { YARD::Parser::Base.new }.should raise_error(ArgumentError, /wrong (number|#) of arguments/)
+      lambda { YARD::Parser::Base.new }.should raise_error(ArgumentError, 
+        /wrong (number|#) of arguments|given 0, expected 2/)
     end
     
     it "should raise NotImplementedError on #initialize" do

data/spec/parser/c_parser_spec.rb

@@ -1,11 +1,14 @@
 require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 begin require 'continuation'; rescue LoadError; end unless RUBY18
 
+class YARD::Parser::CParser; def ensure_loaded!(a, b=1) a end end
+
 describe YARD::Parser::CParser do
   describe '#parse' do
     before(:all) do
       file = File.join(File.dirname(__FILE__), 'examples', 'array.c.txt')
-      @parser = Parser::CParser.new(IO.read(file)).parse
+      @parser = Parser::CParser.new(IO.read(file))
+      @parser.parse
     end
 
     describe 'Array class' do
@@ -48,6 +51,31 @@ describe YARD::Parser::CParser do
         Registry.at('Multifile#extra').docstring.should == ''
       end
     end
+    
+    describe 'Foo' do
+      def parse
+        Registry.clear
+        Parser::CParser.new(@contents).parse
+      end
+
+      it 'should not include comments in docstring source' do
+        @contents = <<-eof
+          /* 
+           * Hello world
+           */
+          VALUE foo(VALUE x) {
+            int value = x;
+          }
+          
+          void Init_Foo() {
+            rb_define_method(rb_cFoo, "foo", foo, 1);
+          }
+        eof
+        parse
+        Registry.at('Foo#foo').source.gsub(/\s\s+/, ' ').should == 
+          "VALUE foo(VALUE x) { int value = x;\n}"
+      end
+    end
   end
 
   describe '#find_override_comment' do
@@ -89,4 +117,4 @@ describe YARD::Parser::CParser do
       neg_self.source.should be_nil
     end
   end
-end if CONTINUATIONS_SUPPORTED
+end

data/spec/parser/ruby/ruby_parser_spec.rb

@@ -203,5 +203,14 @@ describe YARD::Parser::Ruby::RubyParser do
       src = "%w(\na b c\n d e f\n)"
       stmt(src).jump(:qwords_literal).source.should == src
     end
+    
+    it "should parse %w() array in constant declaration" do
+      s = stmt(<<-eof)
+        class Foo
+          FOO = %w( foo bar )
+        end
+      eof
+      s.jump(:qwords_literal).source.should == '%w( foo bar )'
+    end
   end
 end if HAVE_RIPPER

data/spec/registry_spec.rb

@@ -1,6 +1,8 @@
 require File.join(File.dirname(__FILE__), "spec_helper")
 include CodeObjects
 
+require "thread"
+
 describe YARD::Registry do
   before { Registry.clear }
   
@@ -247,38 +249,48 @@ describe YARD::Registry do
   describe 'Thread local' do
     it "should maintain two Registries in separate threads" do
       barrier = 0
+      mutex   = Mutex.new
       threads = []
-      threads << Thread.new do 
+      threads << Thread.new do
         Registry.clear
         YARD.parse_string "# docstring 1\nclass Foo; end"
-        barrier += 1
-        while barrier < 2 do end
+        mutex.synchronize { barrier += 1 }
+        while barrier < 2 do
+          s = "barrier < 2, spinning"
+        end
         Registry.at('Foo').docstring.should == "docstring 1"
       end
       threads << Thread.new do
         Registry.clear
         YARD.parse_string "# docstring 2\nclass Foo; end"
-        barrier += 1
-        while barrier < 2 do end
+        mutex.synchronize { barrier += 1 }
+        while barrier < 2 do
+          s = "barrier < 2, spinning"
+        end
         Registry.at('Foo').docstring.should == "docstring 2"
       end
       threads.each {|t| t.join }
     end
-    
+
     it "should allow setting of yardoc_file in separate threads" do
       barrier = 0
+      mutex   = Mutex.new
       threads = []
-      threads << Thread.new do 
+      threads << Thread.new do
         Registry.yardoc_file.should == '.yardoc'
         Registry.yardoc_file = 'foo'
-        barrier += 1
-        while barrier == 1 do end
+        mutex.synchronize { barrier += 1 }
+        while barrier == 1 do
+          s = "barrier = 1, spinning"
+        end
         Registry.yardoc_file.should == 'foo'
       end
       threads << Thread.new do
-        while barrier == 0 do end
+        while barrier == 0 do
+          s = "barrier = 0, spinning"
+        end
         Registry.yardoc_file.should == '.yardoc'
-        barrier += 1
+        mutex.synchronize { barrier += 1 }
         Registry.yardoc_file = 'foo2'
       end
       threads.each {|t| t.join }

data/spec/templates/helpers/html_helper_spec.rb

@@ -30,12 +30,20 @@ describe YARD::Templates::Helpers::HtmlHelper do
       end
     end
     
+    it "should support utf8 as an encoding value for utf-8" do
+      type = 'utf8'
+      ENV.should_receive(:[]).with('LANG').and_return(type) if RUBY18
+      Encoding.default_external.should_receive(:name).and_return(type) if defined?(Encoding)
+      charset.should == 'utf-8'
+    end
+    
     it "should take file encoding if there is a file" do
       @file = OpenStruct.new(:contents => 'foo'.force_encoding('sjis'))
       charset.should == 'Shift_JIS' # not the correct charset name, but good enough
     end if RUBY19
 
     it "should take file encoding if there is a file" do
+      ENV.stub!(:[]).with('LANG').and_return('utf-8') if RUBY18
       @file = OpenStruct.new(:contents => 'foo')
       charset.should == 'utf-8'
     end if RUBY18
@@ -110,6 +118,7 @@ describe YARD::Templates::Helpers::HtmlHelper do
     end
     
     it "should include file and htmlify it" do
+      load_markup_provider(:rdoc)
       File.should_receive(:file?).with('foo.rdoc').and_return(true)
       File.should_receive(:read).with('foo.rdoc').and_return('= HI')
       htmlify("{include:file:foo.rdoc}", :rdoc).gsub(/\s+/, '').should == "<p><h1>HI</h1></p>"
@@ -119,7 +128,18 @@ describe YARD::Templates::Helpers::HtmlHelper do
       log.enter_level(Logger::FATAL) do
         pending 'This test depends on markdown' unless markup_class(:markdown)
       end
-      htmlify('http://example.com', :markdown).should include('<a href="http://example.com"')
+      htmlify('http://example.com', :markdown).chomp.should ==
+        '<p><a href="http://example.com">http://example.com</a></p>'
+    end
+    
+    it "should not autolink URLs inside of {} (markdown specific)" do
+      log.enter_level(Logger::FATAL) do
+        pending 'This test depends on markdown' unless markup_class(:markdown)
+      end
+      htmlify('{http://example.com Title}', :markdown).chomp.should =~
+        %r{<p><a href="http://example.com".*>Title</a></p>}
+      htmlify('{http://example.com}', :markdown).chomp.should =~
+        %r{<p><a href="http://example.com".*>http://example.com</a></p>}
     end
   end
   
@@ -390,14 +410,30 @@ describe YARD::Templates::Helpers::HtmlHelper do
         :multitype => "- (Type, ...) <strong>foo</strong>",
         :void => "- (void) <strong>foo</strong>",
         :hide_void => "- <strong>foo</strong>",
-        :block => "- (Object) <strong>foo</strong> {|a, b, c| ... }"
+        :block => "- (Object) <strong>foo</strong> {|a, b, c| ... }",
+        :empty_overload => '- (String) <strong>foobar</strong>'
       }
     end
     
     def format_types(types, brackets = false) types.join(", ") end
-    def signature(obj) super(obj, false).strip end
+    def signature(obj, link = false) super(obj, link).strip end
     
     it_should_behave_like "signature"
+    
+    it "should link to regular method if overload name does not have the same method name" do
+      YARD.parse_string <<-eof
+        class Foo
+          # @overload bar(a, b, c)
+          def foo; end
+        end
+      eof
+      serializer = mock(:serializer)
+      serializer.stub!(:serialized_path).with(Registry.at('Foo')).and_return('')
+      stub!(:serializer).and_return(serializer)
+      stub!(:object).and_return(Registry.at('Foo'))
+      signature(Registry.at('Foo#foo').tag(:overload), true).should == 
+        "<a href=\"#foo-instance_method\" title=\"#bar (instance method)\">- <strong>bar</strong>(a, b, c) </a>"
+    end
   end
 
   describe '#html_syntax_highlight' do

data/spec/templates/helpers/shared_signature_examples.rb

@@ -108,4 +108,14 @@ shared_examples_for "signature" do
     eof
     signature(Registry.at('#foo')).should == @results[:block]
   end
+  
+  it "should use regular return tag if the @overload is empty" do
+    YARD.parse_string <<-'eof'
+      # @overload foobar
+      #   Hello world
+      # @return [String]
+      def foo; end
+    eof
+    signature(Registry.at('#foo').tag(:overload)).should == @results[:empty_overload]
+  end
 end

data/spec/templates/helpers/text_helper_spec.rb

@@ -20,7 +20,8 @@ describe YARD::Templates::Helpers::TextHelper do
         :multitype => "root.foo -> (Type, ...)",
         :void => "root.foo -> void",
         :hide_void => "root.foo",
-        :block => "root.foo {|a, b, c| ... } -> Object"
+        :block => "root.foo {|a, b, c| ... } -> Object",
+        :empty_overload => 'root.foobar -> String'
       }
     end
     

data/spec/templates/onefile_spec.rb

@@ -30,11 +30,11 @@ describe YARD::Templates::Engine.template(:default, :onefile) do
         def bar; end
       end
     eof
+    readme = CodeObjects::ExtraFileObject.new('README', 
+      "# This is a code comment\n\n# Top of file\n\n\nclass C; end")
     Templates::Engine.generate Registry.all(:class), 
       :serializer => StringSerializer.new(files, string),
-      :onefile => true, :format => :html, :files => [
-        CodeObjects::ExtraFileObject.new('README', 
-          "# This is a code comment\n\n# Top of file\n\n\nclass C; end"),
+      :onefile => true, :format => :html, :readme => readme, :files => [readme,
         CodeObjects::ExtraFileObject.new('LICENSE', 'This is a license!')
       ]
     files.should == ['index.html']

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

@@ -2,8 +2,6 @@ include Helpers::ModuleHelper
 
 def init
   options[:objects] = objects = run_verifier(options[:objects])
-  options[:files] = ([options[:readme]] + options[:files]).uniq.compact
-  options[:readme] = options[:files].first
   
   return serialize_onefile if options[:onefile]
   generate_assets

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

@@ -17,6 +17,7 @@ end
 private
 
 def parse_top_comments_from_file
+  return @readme.contents unless @readme.filename =~ /\.rb$/
   data = ""
   tokens = TokenList.new(@readme.contents)
   tokens.each do |token|

metadata

@@ -2,7 +2,7 @@
 name: yard
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors: 
 - Loren Segal
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-18 00:00:00 -04:00
+date: 2011-06-14 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -207,6 +207,7 @@ files:
 - lib/yard/verifier.rb
 - lib/yard.rb
 - spec/cli/command_parser_spec.rb
+- spec/cli/command_spec.rb
 - spec/cli/config_spec.rb
 - spec/cli/diff_spec.rb
 - spec/cli/gems_spec.rb
@@ -529,7 +530,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yard
-rubygems_version: 1.3.8
+rubygems_version: 1.3.9.1
 signing_key: 
 specification_version: 3
 summary: Documentation tool for consistent and usable documentation in Ruby.