yard 0.7.1 → 0.7.2

data/lib/yard/handlers/ruby/legacy/macro_handler.rb

@@ -10,7 +10,6 @@ module YARD
           namespace_only
 
           process do
-            return if namespace == Registry.root
             globals.__attached_macros ||= {}
             if !globals.__attached_macros[caller_method]
               return if Ruby::MacroHandler::IGNORE_METHODS[caller_method]

data/lib/yard/handlers/ruby/macro_handler.rb

@@ -13,7 +13,6 @@ module YARD
           private_constant).map {|n| [n, true] }.flatten]
         
         process do
-          return if namespace == Registry.root
           globals.__attached_macros ||= {}
           if !globals.__attached_macros[caller_method]
             return if IGNORE_METHODS[caller_method]

data/lib/yard/handlers/ruby/macro_handler_methods.rb

@@ -71,7 +71,7 @@ module YARD
           name = nil
           [:method, :attribute, :overload].each do |tag_name|
             if tag = @docstring.tag(tag_name)
-              name = tag.send(tag == :overload ? :text : :name).to_s
+              name = tag.send(tag_name == :attribute ? :text : :name).to_s
               if tag_name == :method && name =~ /\(|\s/
                 overload = Tags::OverloadTag.new(:overload, name)
                 @docstring.add_tag(overload)

data/lib/yard/logging.rb

@@ -38,6 +38,19 @@ module YARD
       error "Stack trace:" +
         exc.backtrace[0..5].map {|x| "\n\t#{x}" }.join + "\n"
     end
+    
+    # Warns that the Ruby environment does not support continuations. Applies
+    # to JRuby, Rubinius and MacRuby. This warning will only display once
+    # per Ruby process.
+    # 
+    # @return [void]
+    def warn_no_continuations
+      return if CONTINUATIONS_SUPPORTED
+      return if $NO_CONTINUATION_WARNING
+      $NO_CONTINUATION_WARNING = true
+      warn "JRuby/MacRuby/Rubinius do not implement Kernel#callcc and cannot " +
+           "load files in order. You must specify the correct order manually."
+    end
 
     # Sets the logger level for the duration of the block
     #

data/lib/yard/parser/c_parser.rb

@@ -34,12 +34,8 @@ module YARD
       def ensure_loaded!(object, max_retries = 1)
         return if object.is_a?(CodeObjects::RootObject)
         unless CONTINUATIONS_SUPPORTED
-          unless $NO_CONTINUATION_WARNING
-            $NO_CONTINUATION_WARNING = true
-            log.warn "JRuby/MacRuby/Rubinius do not implement Kernel#callcc and cannot " +
-              "load files in order. You must specify the correct order manually."
-          end
-          raise NamespaceMissingError, object
+          log.warn_no_continuations
+          raise Handlers::NamespaceMissingError, object
         end
 
         retries = 0
@@ -162,7 +158,7 @@ module YARD
 
           # see if we can find the whole body
 
-          re = Regexp.escape(body_text) + '[^(]*^\{.*?^\}'
+          re = Regexp.escape(body_text) + '[^(]*\{.*?\}'
           body_text = $& if /#{re}/m =~ content
 
           # The comment block may have been overridden with a 'Document-method'
@@ -175,7 +171,7 @@ module YARD
           comment = override_comment if override_comment
 
           object.docstring = parse_comments(object, comment) if comment
-          object.source = body_text
+          object.source = body_text.gsub(/\A#{Regexp.quote comment}/, '')
         when %r{((?>/\*.*?\*/\s*))^\s*\#\s*define\s+#{func_name}\s+(\w+)}m
           comment = $1
           find_method_body(object, $2, content)

data/lib/yard/parser/ruby/legacy/statement_list.rb

@@ -356,7 +356,7 @@ module YARD
       # @return [Boolean] whether or not the current statement's parentheses and blocks
       #   are balanced after +tk+
       def balances?(tk)
-        unless @last_ns_tk.class == TkALIAS || @before_last_ns_tk.class == TkALIAS
+        unless [TkALIAS, TkDEF].include?(@last_ns_tk.class) || @before_last_ns_tk.class == TkALIAS 
           if [TkLPAREN, TkLBRACK, TkLBRACE, TkDO, TkBEGIN].include?(tk.class)
             @level += 1
           elsif OPEN_BLOCK_TOKENS.include?(tk.class)

data/lib/yard/parser/ruby/ruby_parser.rb

@@ -331,15 +331,15 @@ module YARD
         def on_qwords_new(*args)
           node = LiteralNode.new(:qwords_literal, args)
           if @map[:qwords_beg]
-            sstart, lstart = *@map[:qwords_beg].pop
-            node.source_range = Range.new(sstart-1, @ns_charno)
+            lstart, sstart = *@map[:qwords_beg].pop
+            node.source_range = Range.new(sstart, @ns_charno-1)
             node.line_range = Range.new(lstart, lineno)
           end
           node
         end
         
         def on_qwords_add(list, item)
-          list.source_range = (list.source_range.first..@ns_charno)
+          list.source_range = (list.source_range.first..@ns_charno-1)
           list.line_range = (list.line_range.first..lineno)
           list.push(item)
           list

data/lib/yard/parser/source_parser.rb

@@ -62,7 +62,7 @@ module YARD
         # @param [Array<String, Regexp>] excluded a list of excluded path matchers
         # @param [Fixnum] level the logger level to use during parsing. See
         #   {YARD::Logger}
-        # @return the parser object that was used to parse the source.
+        # @return [void]
         def parse(paths = ["{lib,app}/**/*.rb", "ext/**/*.c"], excluded = [], level = log.level)
           log.debug("Parsing #{paths.inspect} with `#{parser_type}` parser")
           excluded = excluded.map do |path|

data/lib/yard/server/commands/frames_command.rb

@@ -12,7 +12,7 @@ module YARD
           elsif !path.empty?
             page_title = "Object: #{object_path}"
           elsif options[:files] && options[:files].size > 0
-            page_title = "File: #{options[:files].first.sub(/^#{library.source_path}\/?/, '')}"
+            page_title = "File: #{File.basename(options[:files].first.path)}"
             main_url = url_for_file(options[:files].first)
           elsif !path || path.empty?
             page_title = "Documentation for #{library.name} #{library.version ? '(' + library.version + ')' : ''}"

data/lib/yard/server/commands/library_command.rb

@@ -1,3 +1,5 @@
+require 'thread'
+
 module YARD
   module Server
     module Commands
@@ -68,7 +70,6 @@ module YARD
                 yardoc.parse_arguments
               end
               yardoc.options.delete(:serializer)
-              yardoc.options[:files].unshift(*Dir.glob('README*'))
               options.update(yardoc.options.to_hash)
             end
           end

data/lib/yard/tags/library.rb

@@ -95,7 +95,7 @@ module YARD
 
         # Sets the list of tags that should apply to any children inside the
         # namespace they are defined in. For instance, a "@since" tag should
-        # apply to all methods inside a module is it defined in. Transitive
+        # apply to all methods inside a module it is defined in. Transitive
         # tags can be overridden by directly defining a tag on the child object.
         #
         # @return [Array<Symbol>] a list of transitive tags

data/lib/yard/templates/helpers/html_helper.rb

@@ -180,6 +180,12 @@ module YARD
           next(match[1..-1]) if escape
 
           next(match) if name[0,1] == '|'
+          
+          if name == '<a' && title =~ /href=["'](.+?)["'].*>.*<\/a>\s*(.*)\Z/
+            name, title = $1, $2
+            title = nil if title.empty?
+          end
+          
           if object.is_a?(String)
             object
           else
@@ -371,6 +377,9 @@ module YARD
       # @since 0.5.3
       def signature_types(meth, link = true)
         meth = convert_method_to_overload(meth)
+        if meth.respond_to?(:object) && !meth.has_tag?(:return)
+          meth = meth.object
+        end
 
         type = options[:default_return] || ""
         if meth.tag(:return) && meth.tag(:return).types
@@ -429,7 +438,8 @@ module YARD
           else
             link_title = "#{h name} (#{meth.type})"
           end
-          link_url(url_for(meth), title, :title => link_title) + extras_text
+          obj = meth.respond_to?(:object) ? meth.object : meth
+          link_url(url_for(obj), title, :title => link_title) + extras_text
         else
           title + extras_text
         end
@@ -450,13 +460,14 @@ module YARD
         else
           return 'utf-8' unless RUBY19 || lang = ENV['LANG']
           if RUBY19
-            lang = Encoding.default_external.name.downcase
+            lang = ::Encoding.default_external.name.downcase
           else
             lang = lang.downcase.split('.').last
           end
         end
         case lang
         when "ascii-8bit", "us-ascii", "ascii-7bit"; 'iso-8859-1'
+        when "utf8"; 'utf-8'
         else; lang
         end
       end

data/lib/yard/templates/helpers/text_helper.rb

@@ -52,8 +52,12 @@ module YARD
           end
 
           type = options[:default_return] || ""
-          if meth.tag(:return) && meth.tag(:return).types
-            types = meth.tags(:return).map {|t| t.types ? t.types : [] }.flatten.uniq
+          rmeth = meth
+          if !rmeth.has_tag?(:return) && rmeth.respond_to?(:object)
+            rmeth = meth.object
+          end
+          if rmeth.tag(:return) && rmeth.tag(:return).types
+            types = rmeth.tags(:return).map {|t| t.types ? t.types : [] }.flatten.uniq
             first = types.first
             if types.size == 2 && types.last == 'nil'
               type = first + '?'

data/spec/cli/command_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require 'optparse'
+
+describe YARD::CLI::Command do
+  describe '#parse_options' do
+    before do
+      @options = OptionParser.new
+      @saw_foo = false
+      @options.on('--foo') { @saw_foo = true }
+    end
+    
+    def parse(*args)
+      CLI::Command.new.send(:parse_options, @options, args)
+      args
+    end
+
+    it "should skip unrecognized options but continue to next option" do
+      log.should_receive(:warn).with(/Unrecognized.*--list/)
+      log.should_receive(:warn).with(/Unrecognized.*--list2/)
+      parse('--list', '--list2', '--foo')
+      @saw_foo.should be_true
+    end
+    
+    it "should skip unrecognized options and any extra non-option arg that follows" do
+      log.should_receive(:warn).with(/Unrecognized.*--list/)
+      parse('--list', 'foo', '--foo')
+      @saw_foo.should be_true
+    end
+    
+    it "should stop retrying to parse at non-switch argument" do
+      log.should_receive(:warn).with(/Unrecognized.*--list/)
+      args = parse('--list', 'foo', 'foo', 'foo')
+      args.should == %w(foo foo)
+    end
+  end
+end

data/spec/cli/diff_spec.rb

@@ -135,6 +135,7 @@ eof
       File.should_receive(:directory?).any_number_of_times
       File.should_receive(:exist?).with('gem1.gem').and_return(true)
       File.should_receive(:exist?).with('gem2.gem').and_return(true)
+      File.should_receive(:exist?).any_number_of_times
       File.should_receive(:open).with('gem1.gem', 'rb').and_yield(iomock)
       File.should_receive(:open).with('gem2.gem', 'rb')
       FileUtils.should_receive(:mkdir_p)
@@ -152,6 +153,7 @@ eof
       File.should_receive(:directory?).any_number_of_times
       File.should_receive(:exist?).with('gem1.gem').and_return(false)
       File.should_receive(:exist?).with('gem2.gem').and_return(false)
+      File.should_receive(:exist?).any_number_of_times
       @diff.should_receive(:open).with('http://rubygems.org/downloads/gem1.gem').and_yield(iomock)
       @diff.should_receive(:open).with('http://rubygems.org/downloads/gem2.gem')
       FileUtils.should_receive(:mkdir_p)

data/spec/cli/server_spec.rb

@@ -24,11 +24,11 @@ describe YARD::CLI::Server do
   
   def run(*args)
     if @libraries.empty?
-      library = Server::LibraryVersion.new(File.basename(Dir.pwd), nil, '.yardoc')
+      library = Server::LibraryVersion.new(File.basename(Dir.pwd), nil, File.expand_path('.yardoc'))
       @libraries = {library.name => [library]}
     end
     unless @no_verify_libraries
-      @libraries.values.each {|libs| libs.each {|lib| File.should_receive(:exist?).at_least(1).times.with(lib.yardoc_file).and_return(true) } }
+      @libraries.values.each {|libs| libs.each {|lib| File.should_receive(:exist?).at_least(1).times.with(File.expand_path(lib.yardoc_file)).and_return(true) } }
     end
     unless @no_adapter_mock
       @cli.stub!(:adapter).and_return(@adapter)
@@ -40,19 +40,19 @@ describe YARD::CLI::Server do
 
   it "should default to current dir if no library is specified" do
     Dir.should_receive(:pwd).and_return('/path/to/foo')
-    @libraries['foo'] = [Server::LibraryVersion.new('foo', nil, '.yardoc')]
+    @libraries['foo'] = [Server::LibraryVersion.new('foo', nil, File.expand_path('.yardoc'))]
     run
   end
   
   it "should use .yardoc as yardoc file is library list is odd" do
-    @libraries['a'] = [Server::LibraryVersion.new('a', nil,'.yardoc')]
+    @libraries['a'] = [Server::LibraryVersion.new('a', nil, File.expand_path('.yardoc'))]
     run 'a'
   end
   
   it "should force multi library if more than one library is listed" do
     @options[:single_library] = false
-    @libraries['a'] = [Server::LibraryVersion.new('a', nil, 'b')]
-    @libraries['c'] = [Server::LibraryVersion.new('c', nil, '.yardoc')]
+    @libraries['a'] = [Server::LibraryVersion.new('a', nil, File.expand_path('b'))]
+    @libraries['c'] = [Server::LibraryVersion.new('c', nil, File.expand_path('.yardoc'))]
     run %w(a b c)
   end
   
@@ -167,4 +167,4 @@ describe YARD::CLI::Server do
       end
     end
   end
-end
+end

data/spec/cli/yardoc_spec.rb

@@ -416,6 +416,7 @@ describe YARD::CLI::Yardoc do
     end
 
     it "should accept files section only containing extra files" do
+      Dir.should_receive(:glob).with('README*').and_return([])
       @yardoc.parse_arguments *%w( - LICENSE )
       @yardoc.files.should == %w( {lib,app}/**/*.rb ext/**/*.c )
       @yardoc.options[:files].should == [CodeObjects::ExtraFileObject.new('LICENSE', '')]
@@ -444,6 +445,21 @@ describe YARD::CLI::Yardoc do
       log.should_receive(:warn).with(/Could not find readme file: UNKNOWN/)
       @yardoc.parse_arguments *%w( -r UNKNOWN )
     end
+    
+    it "should use first file as readme if no readme is specified when using --one-file" do
+      Dir.should_receive(:glob).with('README*').and_return []
+      Dir.should_receive(:glob).with('lib/*.rb').and_return(['lib/foo.rb'])
+      File.should_receive(:read).with('lib/foo.rb').and_return('')
+      @yardoc.parse_arguments *%w( --one-file lib/*.rb )
+      @yardoc.options[:readme].should == CodeObjects::ExtraFileObject.new('lib/foo.rb', '')
+    end
+    
+    it "should use readme it exists when using --one-file" do
+      Dir.should_receive(:glob).with('README*').and_return ['README']
+      File.should_receive(:read).with('README').and_return('')
+      @yardoc.parse_arguments *%w( --one-file lib/*.rb )
+      @yardoc.options[:readme].should == CodeObjects::ExtraFileObject.new('README', '')
+    end
   end
   
   describe 'Source file arguments' do
@@ -458,7 +474,7 @@ describe YARD::CLI::Yardoc do
       visible_tags = mock(:visible_tags)
       visible_tags.should_receive(:|).ordered.with([:foo])
       visible_tags.should_receive(:-).ordered.with([]).and_return(visible_tags)
-      Tags::Library.should_receive(:define_tag).with(nil, :foo, factory_method)
+      Tags::Library.should_receive(:define_tag).with('Foo', :foo, factory_method)
       Tags::Library.stub!(:visible_tags=)
       Tags::Library.should_receive(:visible_tags).at_least(1).times.and_return(visible_tags)
       @yardoc.parse_arguments("--#{switch}-tag", 'foo')
@@ -468,7 +484,7 @@ describe YARD::CLI::Yardoc do
       visible_tags = mock(:visible_tags)
       visible_tags.should_receive(:|).ordered.with([tag])
       visible_tags.should_receive(:-).ordered.with([tag]).and_return([])
-      Tags::Library.should_receive(:define_tag).with(nil, tag, nil)
+      Tags::Library.should_receive(:define_tag).with(tag.to_s.capitalize, tag, nil)
       Tags::Library.stub!(:visible_tags=)
       Tags::Library.should_receive(:visible_tags).at_least(1).times.and_return(visible_tags)
     end
@@ -478,8 +494,8 @@ describe YARD::CLI::Yardoc do
       @yardoc.parse_arguments('--tag', 'foo:Title of Foo')
     end
 
-    it "should accept --tag without title" do
-      Tags::Library.should_receive(:define_tag).with(nil, :foo, nil)
+    it "should accept --tag without title (and default to captialized tag name)" do
+      Tags::Library.should_receive(:define_tag).with('Foo', :foo, nil)
       @yardoc.parse_arguments('--tag', 'foo')
     end
     

data/spec/handlers/examples/macro_handler_001.rb.txt

@@ -26,6 +26,9 @@ class Foo
   # @attribute
   default_attribute :attr3
   
+  # @attribute custom
+  default_attribute :attr4
+  
   # @method xyz(a, b, c)
   # The foo method
   # @param [String] a
@@ -71,3 +74,10 @@ class Baz < Foo
   parser :y_parser
   none { }
 end
+
+# @method my_other_method
+# Docstring for method
+method_that_makes_a_method
+
+# @macro something
+foobarbaz :beep

data/spec/handlers/examples/method_handler_001.rb.txt

@@ -108,3 +108,15 @@ class E
   
   xyz :a
 end
+
+module F
+  class A
+    def foo; end
+    
+    def end
+    end
+    
+    # PASS
+    def bar; end
+  end
+end

data/spec/handlers/macro_handler_spec.rb

@@ -27,6 +27,11 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MacroHandler"
     obj.should_not be_nil
     obj.should be_writer
   end
+  
+  it "should allow @attribute to define alternate method name" do
+    Registry.at('Foo#attr4').should be_nil
+    Registry.at('Foo#custom').should_not be_nil
+  end
 
   it "should default to creating an instance method for any DSL method with tags" do
     obj = Registry.at('Foo#implicit0')
@@ -137,4 +142,16 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MacroHandler"
     Registry.at('Bar#x_parser').should be_nil
     Registry.at('Baz#y_parser').should_not be_nil
   end
+  
+  it "should handle top-level DSL methods" do
+    obj = Registry.at('#my_other_method')
+    obj.should_not be_nil
+    obj.docstring.should == "Docstring for method"
+  end
+  
+  it "should handle Constant.foo syntax" do
+    obj = Registry.at('#beep')
+    obj.should_not be_nil
+    obj.signature.should == 'def beep(a, b, c)'
+  end
 end