yard 0.8.5.2 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 286e9bb0543c0d2d846d703abf038d42c0d08948
-  data.tar.gz: 1935aea9fce12ae0d560f0c2f4b65240aa688fac
+  metadata.gz: bc6d95eac959d222f86cce2a94f0b06616aa93fa
+  data.tar.gz: de628de21267d778d571fd25ba5aa1665395c5ef
 SHA512:
-  metadata.gz: 425fa8cdc965cd68b71230050e1d5c5741b9339218aeedfc4027b20ba2d15484ba1771c61b4bc0a6663b5c1b009d941644b6be323d9dd8e5a13314464bcd0a8e
-  data.tar.gz: 811d9eae07e7ded34d64e42858f2d9ddd2fad45847636c832f90f326a157fd0933000ce5168f9a6de97224084936c936e7adfbe8339ecdd6af75d9f09a0f5fdb
+  metadata.gz: f368b1eb2d0664d79ea633671dbd100252e6e10a382b39ae400be373264ef5569816706eff9cbd899d1bcbb09bc44394be36c7d642c751a156a0253fe2741560
+  data.tar.gz: 5c3db2fd3f06553727943a76375d48f70645aaba16828a051cc1ac5835ab96ea9987dea80f25c373e61d880d240c12aeb3d509c1e7d13e23172dc1d576eaec10

data/LEGAL

@@ -4,14 +4,6 @@ LEGAL NOTICE INFORMATION
 All the files in this distribution are covered under either the MIT
 license (see the file LICENSE) except some files mentioned below.
 
-lib/parser/c_parser.rb:
-
-  This file includes code from the RDoc distribution. It is under the Ruby
-  license but adds the following copyright:
-
-    RDoc is copyrighted free software by Dave Thomas, Eric Hodel, and others.
-    It is licensed under the same terms as Ruby
-
 lib/parser/ruby/legacy/ruby_lex.rb:
 
   This file is under the Ruby license. YARD uses a modified version of it.

data/README.md

@@ -7,8 +7,8 @@
 **Contributors**: See Contributors section below    
 **Copyright**:    2007-2013    
 **License**:      MIT License    
-**Latest Version**: 0.8.5.2    
-**Release Date**: February 26th 2013    
+**Latest Version**: 0.8.6    
+**Release Date**: April 13th 2013    
 
 ## Synopsis
 
@@ -283,6 +283,13 @@ More options can be seen by typing `yard graph --help`, but here is an example:
 
 ## Changelog
 
+- **April.13.13**: 0.8.6 release
+    - Various fixes and improved Ruby 2.x compatibility support
+    - Added support for `asciidoc` markup type
+    - Added `yard markups` command to list available markup types
+    - Added `yard display` command to display and format an individual object
+    - See {file:docs/WhatsNew.md} for more information on added features.
+
 - **February.26.13**: 0.8.5.2 release
     - Support new keyword argument syntax in method signatures (Ruby 2.x)
 

data/bin/yard

@@ -3,7 +3,7 @@
 # We do all this work just to find the proper load path
 path = __FILE__
 while File.symlink?(path)
-  path = File.expand_path(File.readlink(__FILE__), File.dirname(__FILE__))
+  path = File.expand_path(File.readlink(path), File.dirname(path))
 end
 $:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 

data/bin/yardoc

@@ -3,7 +3,7 @@
 # We do all this work just to find the proper load path
 path = __FILE__
 while File.symlink?(path)
-  path = File.expand_path(File.readlink(__FILE__), File.dirname(__FILE__))
+  path = File.expand_path(File.readlink(path), File.dirname(path))
 end
 $:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 

data/bin/yri

@@ -3,7 +3,7 @@
 # We do all this work just to find the proper load path
 path = __FILE__
 while File.symlink?(path)
-  path = File.expand_path(File.readlink(__FILE__), File.dirname(__FILE__))
+  path = File.expand_path(File.readlink(path), File.dirname(path))
 end
 $:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 

data/docs/WhatsNew.md

@@ -18,6 +18,9 @@
 14. **Added `--api` tag to generate documentation for API sets** (0.8.1)
 15. **Added `--non-transitive-tag` to disable transitive tag** (0.8.3)
 16. **Added `-B/--bind` to bind to a port in yard server** (0.8.4)
+17. **Added `asciidoc` markup type support** (0.8.6)
+18. **Added `yard markups` command to list available markup types** (0.8.6)
+18. **Added `yard display` command to display formatted objects** (0.8.6)
 
 ## Directives (new behavioural tag syntax) (0.8.0)
 
@@ -298,6 +301,41 @@ when parsing modules and classes.
 You can now bind the `yard server` command to a given local port
 with `yard server -B PORT` or `yard server --bind PORT`.
 
+## Added `asciidoc` markup type support (0.8.6)
+
+Support for the AsciiDoc markup type is now introduced using the `asciidoc`
+markup type (`yard doc -m asciidoc`). Requires the
+[asciidoctor](http://rubygems.org/gems/asciidoctor) RubyGem library to be
+installed before running YARD.
+
+## Added `yard markups` command to list available markup types (0.8.6)
+
+You can now list all available markup types and their respective providers by
+typing `yard markups`. This list also includes the file extensions used to
+auto-identify markup types for extra files and READMEs. To use a markup in
+the list, call `yard doc` with `-m MARKUP_TYPE`. To select a specific markup
+provider library, pass the `-M PROVIDER_NAME` option.
+
+## Added `yard display` command to display formatted objects (0.8.6)
+
+<p class="note">This feature requires the .yardoc registry to have already been
+  generated. To generate the registry, run <code>yard doc -n</code>.</p>
+
+You can now display a single object (or a list of objects) in the YARD registry
+using the `yard display OBJECT ...` command. For example, to display the
+`YARD::CodeObjects` module as text (the way it is displayed in `yri`), type:
+
+    $ yard display YARD::CodeObjects
+
+You can also format individual objects as HTML. For example, you can format
+the above object as HTML and pipe the contents into a file readable by a
+web browser:
+
+    $ yard display -f html YARD::CodeObjects > codeobjects.html
+
+Custom templating options from `yard doc` can also be used, see
+`yard display --help` for more options.
+
 # What's New in 0.7.x?
 
 1. **Macro support and detection of DSL methods** (0.7.0)

data/lib/yard/autoload.rb

@@ -7,10 +7,12 @@ module YARD
     autoload :CommandParser,   __p('cli/command_parser')
     autoload :Config,          __p('cli/config')
     autoload :Diff,            __p('cli/diff')
+    autoload :Display,         __p('cli/display')
     autoload :Gems,            __p('cli/gems')
     autoload :Graph,           __p('cli/graph')
     autoload :Help,            __p('cli/help')
     autoload :List,            __p('cli/list')
+    autoload :MarkupTypes,     __p('cli/markup_types')
     autoload :Server,          __p('cli/server')
     autoload :Stats,           __p('cli/stats')
     autoload :Yardoc,          __p('cli/yardoc')
@@ -253,6 +255,7 @@ module YARD
     module Helpers # Namespace for template helpers
       module Markup # Namespace for markup providers
         autoload :RDocMarkup,               __p('templates/helpers/markup/rdoc_markup')
+        autoload :RDocMarkdown,             __p('templates/helpers/markup/rdoc_markdown')
       end
 
       autoload :BaseHelper,                 __p('templates/helpers/base_helper')

data/lib/yard/cli/command_parser.rb

@@ -31,17 +31,19 @@ module YARD
       end
 
       self.commands = SymbolHash[
-        :config => Config,
-        :diff   => Diff,
-        :doc    => Yardoc,
-        :gems   => Gems,
-        :graph  => Graph,
-        :help   => Help,
-        :list   => List,
-        :ri     => YRI,
-        :server => Server,
-        :stats  => Stats,
-        :i18n   => I18n
+        :config  => Config,
+        :diff    => Diff,
+        :display => Display,
+        :doc     => Yardoc,
+        :gems    => Gems,
+        :graph   => Graph,
+        :help    => Help,
+        :list    => List,
+        :markups => MarkupTypes,
+        :ri      => YRI,
+        :server  => Server,
+        :stats   => Stats,
+        :i18n    => I18n
       ]
 
       self.default_command = :doc

data/lib/yard/cli/diff.rb

@@ -101,6 +101,7 @@ module YARD
       end
 
       def load_git_commit(commit)
+        Registry.clear
         commit_path = 'git_commit' + commit.gsub(/\W/, '_')
         tmpdir = File.join(Dir.tmpdir, commit_path)
         log.info "Expanding #{commit} to #{tmpdir}..."
@@ -266,4 +267,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/cli/display.rb

@@ -0,0 +1,43 @@
+module YARD
+  module CLI
+    # Display one object
+    # @since 0.8.6
+    class Display < Yardoc
+      def description; 'Displays a formatted object' end
+
+      def initialize(*args)
+        super
+        options.format = :text # default for this command
+      end
+
+      # Runs the commandline utility, parsing arguments and displaying an object
+      # from the {Registry}.
+      #
+      # @param [Array<String>] args the list of arguments.
+      # @return [void]
+      def run(*args)
+        return unless parse_arguments(*args)
+        @objects.each do |obj|
+          log.puts obj.format(options)
+        end
+      end
+
+      # Parses commandline options.
+      # @param [Array<String>] args each tokenized argument
+      def parse_arguments(*args)
+        opts = OptionParser.new
+        opts.banner = "Usage: yard display [options] OBJECT [OTHER OBJECTS]"
+        general_options(opts)
+        output_options(opts)
+        parse_options(opts, args)
+
+        Registry.load
+        @objects = args.map {|o| Registry.at(o) }
+
+        # validation
+        return false if @objects.any? {|o| o.nil? }
+        verify_markup_options
+      end
+    end
+  end
+end

data/lib/yard/cli/markup_types.rb

@@ -0,0 +1,33 @@
+module YARD
+  module CLI
+    # Lists all markup types
+    # @since 0.8.6
+    class MarkupTypes < Command
+      def description; 'Lists all available markup types and libraries' end
+
+      # Runs the commandline utility, parsing arguments and displaying a
+      # list of markup types
+      #
+      # @param [Array<String>] args the list of arguments.
+      # @return [void]
+      def run(*args)
+        log.puts "Available markup types for `doc' command:"
+        log.puts
+        types = Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS
+        exts = Templates::Helpers::MarkupHelper::MARKUP_EXTENSIONS
+        types.sort_by {|name, _| name.to_s }.each do |name, providers|
+          log.puts "[#{name}]"
+          libs = providers.map {|p| p[:lib] }.compact
+          if libs.size > 0
+            log.puts "  Providers: #{libs.join(" ")}"
+          end
+          if exts[name]
+            log.puts "  Extensions: #{exts[name].map {|e| ".#{e}"}.join(" ")}"
+          end
+
+          log.puts
+        end
+      end
+    end
+  end
+end

data/lib/yard/code_objects/root_object.rb

@@ -6,6 +6,7 @@ module YARD
       def path; @path ||= "" end
       def inspect; @inspect ||= "#<yardoc root>" end
       def root?; true end
+      def title; 'Top Level Namespace' end
       def equal?(other)
         other == :root ? true : super(other)
       end

data/lib/yard/docstring.rb

@@ -71,11 +71,14 @@ module YARD
     #   docstring. May be nil.
     # @param [String] raw_data the complete docstring, including all
     #   original formatting and any unparsed tags/directives.
-    def self.new!(text, tags = [], object = nil, raw_data = nil)
+    # @param [CodeObjects::Base, nil] A reference object used for the base set
+    #   of documentation / tag information.
+    def self.new!(text, tags = [], object = nil, raw_data = nil, ref_object = nil)
       docstring = allocate
       docstring.replace(text, false)
       docstring.object = object
       docstring.add_tag(*tags)
+      docstring.instance_variable_set("@unresolved_reference", ref_object)
       docstring.instance_variable_set("@all", raw_data) if raw_data
       docstring
     end
@@ -168,13 +171,14 @@ module YARD
     def summary
       resolve_reference
       return @summary if @summary
+      stripped = self.gsub(/<.+?>/m, '').strip
       open_parens = ['{', '(', '[']
       close_parens = ['}', ')', ']']
       num_parens = 0
       idx = length.times do |index|
-        case self[index, 1]
+        case stripped[index, 1]
         when ".", "\r", "\n"
-          next_char = self[index + 1, 1].to_s
+          next_char = stripped[index + 1, 1].to_s
           if num_parens == 0 && next_char =~ /^\s*$/
             break index - 1
           end
@@ -184,7 +188,7 @@ module YARD
           num_parens -= 1
         end
       end
-      @summary = self[0..idx]
+      @summary = stripped[0..idx]
       if !@summary.empty? && @summary !~ /\A\s*\{include:.+\}\s*\Z/
         @summary += '.'
       end

data/lib/yard/docstring_parser.rb

@@ -92,7 +92,7 @@ module YARD
     # @return [Docstring] translates parsed text into
     #   a Docstring object.
     def to_docstring
-      Docstring.new!(text, tags, object, raw_text)
+      Docstring.new!(text, tags, object, raw_text, reference)
     end
 
     # @!group Parsing Methods

data/lib/yard/handlers/c/base.rb

@@ -85,7 +85,7 @@ module YARD
         # @group Processing other files
 
         def process_file(file, object)
-          file = File.cleanpath(File.relative_path(statement.file, file))
+          file = File.cleanpath(file)
           return if processed_files[file]
           processed_files[file] = file
           begin

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

@@ -10,7 +10,14 @@ class YARD::Handlers::Ruby::Legacy::MethodHandler < YARD::Handlers::Ruby::Legacy
       meth, args = $1, $2
       meth.gsub!(/\s+/,'')
       args = tokval_list(YARD::Parser::Ruby::Legacy::TokenList.new(args), :all)
-      args.map! {|a| k, v = *a.split('=', 2); [k.strip, (v ? v.strip : nil)] } if args
+      args.map! do |a|
+        k, v, r = *a.split(/(:)|=/, 2)
+        if r
+          k += v
+          v = r
+        end
+        [k.strip, (v ? v.strip : nil)]
+      end if args
     else
       raise YARD::Parser::UndocumentableError, "method: invalid name"
     end

data/lib/yard/logging.rb

@@ -12,7 +12,8 @@ module YARD
 
     # @return [IO] the IO object being logged to
     # @since 0.8.2
-    attr_accessor :io
+    def io; @logdev end
+    def io=(pipe) @logdev = pipe end
 
     # @return [Boolean] whether backtraces should be shown (by default
     #   this is on).

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

@@ -200,6 +200,7 @@ module YARD
         [:TkINTEGER,    TkVal],
         [:TkFLOAT,      TkVal],
         [:TkSYMBOL,     TkVal],
+        [:TkLABEL,      TkVal],
         [:TkSTRING,     TkVal],
         [:TkXSTRING,    TkVal],
         [:TkREGEXP,     TkVal],

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

@@ -53,7 +53,12 @@ module YARD
       end
 
       def convert_token(lex, tk)
-        if TkSYMBEG === tk && next_tk = lex.token
+        if TkIDENTIFIER === tk && lex.peek == ':'
+          next_tk = lex.token
+          sym = TkLABEL.new(tk.line_no, tk.char_no, nil)
+          sym.lex_state = lex.lex_state
+          sym.set_text(tk.text + next_tk.text)
+        elsif TkSYMBEG === tk && next_tk = lex.token
           sym = TkSYMBOL.new(tk.line_no, tk.char_no, nil)
           sym.lex_state = lex.lex_state
           sym.set_text(tk.text + next_tk.text)

data/lib/yard/parser/source_parser.rb

@@ -470,7 +470,6 @@ module YARD
         if content =~ ENCODING_LINE
           content.force_encoding($1)
         else
-          old_encoding = content.encoding
           content.force_encoding('binary')
           ENCODING_BYTE_ORDER_MARKS.each do |encoding, bom|
             bom.force_encoding('binary')
@@ -479,7 +478,7 @@ module YARD
               return content
             end
           end
-          content.force_encoding(old_encoding)
+          content.force_encoding('utf-8') # UTF-8 is default encoding
           content
         end
       end

data/lib/yard/tags/directives.rb

@@ -404,7 +404,7 @@ module YARD
         obj.signature = method_signature
         obj.parameters = OverloadTag.new(:overload, method_signature).parameters
         obj.docstring = Docstring.new!(parser.text, parser.tags, obj,
-          parser.raw_text)
+          parser.raw_text, parser.reference)
         handler.register_module_function(obj)
         obj
       end

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

@@ -121,9 +121,9 @@ module YARD::Templates::Helpers
 
       case object
       when YARD::CodeObjects::Base, YARD::CodeObjects::Proxy
-        object.path
+        object.title
       when String, Symbol
-        P(object).path
+        P(object).title
       else
         object
       end
@@ -195,7 +195,7 @@ module YARD::Templates::Helpers
       when YARD::CodeObjects::RootObject
         "Top Level Namespace"
       else
-        format_object_type(object) + ": " + object.path
+        format_object_type(object) + ": " + object.title
       end
     end
 

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

@@ -67,6 +67,13 @@ module YARD
         end
       end
 
+      # Converts Asciidoc to HTML
+      # @param [String] text input Asciidoc text
+      # @return [String] output HTML
+      def html_markup_asciidoc(text)
+        markup_class(:asciidoc).render(text)
+      end
+
       # Converts Textile to HTML
       # @param [String] text the input Textile text
       # @return [String] output HTML
@@ -246,9 +253,7 @@ module YARD
       def link_object(obj, otitle = nil, anchor = nil, relative = true)
         return otitle if obj.nil?
         obj = Registry.resolve(object, obj, true, true) if obj.is_a?(String)
-        if !otitle && obj.root?
-          title = "Top Level Namespace"
-        elsif otitle
+        if otitle
           title = otitle.to_s
         elsif object.is_a?(CodeObjects::Base)
           # Check if we're linking to a class method in the current

data/lib/yard/templates/helpers/markup/rdoc_markdown.rb

@@ -0,0 +1,22 @@
+module YARD
+  module Templates
+    module Helpers
+      module Markup
+        begin require 'rdoc'; rescue LoadError; end
+        begin
+          require 'rdoc/markdown'
+        rescue LoadError
+          raise NameError, "could not load RDoc Markdown support (rdoc is too old)"
+        end
+
+        class RDocMarkdown < RDocMarkup
+          def initialize(text)
+            super RDoc::Markdown.new.parse(text)
+          end
+
+          def fix_typewriter(html) html end
+        end
+      end
+    end
+  end
+end

data/lib/yard/templates/helpers/markup/rdoc_markup.rb

@@ -13,7 +13,11 @@ module YARD
             if defined?(RDoc::VERSION) && RDoc::VERSION >= '4.0.0' &&
                defined?(RDoc::Options)
             then
-              def initialize; super(RDoc::Options.new) end
+              def initialize
+                options = RDoc::Options.new
+                options.pipe = true
+                super(options)
+              end
             end
           end
         rescue LoadError

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

@@ -28,6 +28,7 @@ module YARD
           {:lib => :bluecloth, :const => 'BlueCloth'},
           {:lib => :maruku, :const => 'Maruku'},
           {:lib => :'rpeg-markdown', :const => 'PEGMarkdown'},
+          {:lib => :rdoc, :const => 'YARD::Templates::Helpers::Markup::RDocMarkdown'},
         ],
         :textile => [
           {:lib => :redcloth, :const => 'RedCloth'},
@@ -38,6 +39,9 @@ module YARD
         :rdoc => [
           {:lib => nil, :const => 'YARD::Templates::Helpers::Markup::RDocMarkup'},
         ],
+        :asciidoc => [
+          {:lib => :asciidoctor, :const => 'Asciidoctor'}
+        ],
         :ruby => [],
         :text => [],
         :pre  => [],
@@ -53,6 +57,7 @@ module YARD
         :html => ['htm', 'html', 'shtml'],
         :text => ['txt'],
         :textile => ['textile', 'txtile'],
+        :asciidoc => ['asciidoc'],
         :markdown => ['markdown', 'md', 'mdown', 'mkd'],
         :rdoc => ['rdoc'],
         :ruby => ['rb', 'ru']

data/lib/yard/version.rb

@@ -1,3 +1,3 @@
 module YARD
-  VERSION = "0.8.5.2"
+  VERSION = "0.8.6"
 end

data/spec/cli/display_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe YARD::CLI::Display do
+  it "displays an object" do
+    Registry.stub(:load)
+    foo = CodeObjects::ClassObject.new(:root, :Foo)
+    foo.docstring = 'Foo bar'
+    output = foo.format
+
+    YARD::CLI::Display.run('-f', 'text', 'Foo')
+    log.io.string.strip.should eq(output.strip)
+  end
+end

data/spec/cli/markup_types_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe YARD::CLI::MarkupTypes do
+  it "lists all available markup types" do
+    YARD::CLI::MarkupTypes.run
+    data = log.io.string
+    exts = YARD::Templates::Helpers::MarkupHelper::MARKUP_EXTENSIONS
+    YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS.each do |name, providers|
+      data.should match(/\b#{name}\b/)
+
+      # Match all extensions
+      exts[name].each do |ext|
+        data.should include(".#{ext}")
+      end if exts[name]
+
+      # Match all provider libs
+      providers.each do |provider|
+        data.should match(/\b#{provider[:lib]}\b/)
+      end
+    end
+  end
+end

data/spec/docstring_spec.rb

@@ -52,6 +52,11 @@ describe YARD::Docstring do
       5.times { o1.summary.should == "Hello." }
     end
 
+    it "should strip HTML before summarizing" do
+      doc = Docstring.new("<p>Hello <b>world</b></p>.")
+      doc.summary.should == 'Hello world.'
+    end
+
     it "should return the first sentence" do
       o = Docstring.new("DOCSTRING. Another sentence")
       o.summary.should == "DOCSTRING."
@@ -302,4 +307,19 @@ describe YARD::Docstring do
       doc.dup.line_range.should == doc.line_range
     end
   end
+
+  describe 'reference docstrings' do
+    it 'allows for construction of docstring with ref object' do
+      YARD.parse_string <<-eof
+        class A
+          # Docstring
+          def a; end
+          # (see #a)
+          def b; end
+        end
+      eof
+      YARD::Registry.at('A#b').docstring.should == 'Docstring'
+      YARD::Registry.clear
+    end
+  end
 end

data/spec/handlers/c/method_handler_spec.rb

@@ -184,16 +184,17 @@ describe YARD::Handlers::C::MethodHandler do
        * Foo bar!
        */
     eof
-    File.should_receive(:read).with('other.c').and_return(other)
-    parse <<-eof
+    File.should_receive(:read).with('foo/bar/other.c').and_return(other)
+    src = <<-eof
       void Init_Foo() {
         mFoo = rb_define_module("Foo");
-        rb_define_method(mFoo, "foo", foo, 0); // in other.c
-        rb_define_method(mFoo, "initialize", foo, 0); // in other.c
-        mBar = rb_define_module_under(mFoo, "Bar"); // in other.c
-        rb_define_method(mBar, "baz", foo, 0); // in other.c
+        rb_define_method(mFoo, "foo", foo, 0); // in foo/bar/other.c
+        rb_define_method(mFoo, "initialize", foo, 0); // in foo/bar/other.c
+        mBar = rb_define_module_under(mFoo, "Bar"); // in foo/bar/other.c
+        rb_define_method(mBar, "baz", foo, 0); // in foo/bar/other.c
       }
     eof
+    parse(src, 'foo/bar/baz/init.c')
     Registry.at('Foo#foo').docstring.should == 'Foo bar!'
     Registry.at('Foo#initialize').docstring.should == 'Foo bar!'
     Registry.at('Foo::Bar#baz').docstring.should == 'Foo bar!'

data/spec/handlers/c/spec_helper.rb

@@ -1,8 +1,10 @@
 require File.dirname(__FILE__) + "/../spec_helper"
 
-def parse(src)
+def parse(src, file = '(stdin)')
   YARD::Registry.clear
-  YARD.parse_string(src, :c)
+  parser = YARD::Parser::SourceParser.new(:c)
+  parser.file = file
+  parser.parse(StringIO.new(src))
 end
 
 def parse_init(src)

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

@@ -33,6 +33,14 @@ describe YARD::Parser::Ruby::Legacy::TokenList do
       x[4].class.should == TkDSTRING
       x.to_s.should == 'x = "hello #{world}"' + "\n"
     end
+
+    it 'handles label syntax' do
+      x = TokenList.new('a:1,b:2')
+      x[0].class.should == TkLABEL
+      x[0].text.should == 'a:'
+      x[3].class.should == TkLABEL
+      x[3].text.should == 'b:'
+    end
   end
 
   describe '#to_s' do

data/spec/parser/source_parser_spec.rb

@@ -548,7 +548,7 @@ describe YARD::Parser::SourceParser do
           result = parser.parse("tmpfile")
           if HAVE_RIPPER && YARD.ruby19?
             if msg == :should_not
-              default_encoding = YARD.ruby2? ? 'UTF-8' : 'US-ASCII'
+              default_encoding = 'UTF-8'
               result.enumerator[0].source.encoding.to_s.should eq(default_encoding)
             else
               ['Shift_JIS', 'Windows-31J', 'UTF-8'].send(msg, include(

data/spec/spec_helper.rb

@@ -121,4 +121,8 @@ module Kernel
   end
 end if ENV['TM_APP_PATH']
 
+RSpec.configure do |config|
+  config.before(:each) { log.io = StringIO.new }
+end
+
 include YARD

data/spec/templates/helpers/base_helper_spec.rb

@@ -43,7 +43,7 @@ describe YARD::Templates::Helpers::BaseHelper do
     end
 
     it "should return a path if argument is a Proxy or object" do
-      link_object(Registry.root).should == ""
+      link_object(Registry.root).should == "Top Level Namespace"
       link_object(P("Array")).should == "Array"
     end
 
@@ -165,10 +165,10 @@ describe YARD::Templates::Helpers::BaseHelper do
       format_object_title(Registry.root).should == "Top Level Namespace"
     end
 
-    it "should return 'type: path' in other cases" do
+    it "should return 'type: title' in other cases" do
       obj = mock(:object)
       obj.stub!(:type).and_return(:class)
-      obj.stub!(:path).and_return("A::B::C")
+      obj.stub!(:title).and_return("A::B::C")
       format_object_title(obj).should == "Class: A::B::C"
     end
   end

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

@@ -7,5 +7,5 @@ def init
 end
 
 def format_object_title(object)
-  "Class: #{object.path} < #{object.superclass.path}"
+  "Class: #{object.title} < #{object.superclass.title}"
 end

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

@@ -2,11 +2,7 @@
 <% @items.each do |item| %>
   <li class="r<%= n %> <%= item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
     <%= linkify item, h(item.name(true)) %>
-    <% if item.namespace && !item.namespace.root? %>
-      <small><%= item.namespace %></small>
-    <% else %>
-      <small>Top Level Namespace</small>
-    <% end %>
+    <small><%= item.namespace.title %></small>
   </li>
   <% n = n == 2 ? 1 : 2 %>
 <% end %>

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

@@ -17,6 +17,7 @@ function fullListSearch() {
   searchCache = [];
   $('#full_list li').each(function() {
     var link = $(this).find('.object_link a');
+    if (link.length === 0) return;
     var fullName = link.attr('title').split(' ')[0];
     searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
   });
@@ -41,7 +42,7 @@ function fullListSearch() {
       $('#full_list li').removeClass('found').each(function() {
 
         var link = $(this).find('.object_link a');
-        link.text(link.text());
+        if (link.length > 0) link.text(link.text());
       });
       if (clicked) {
         clicked.parents('ul').each(function() {
@@ -110,6 +111,10 @@ clicked = null;
 function linkList() {
   $('#full_list li, #full_list li a:last').click(function(evt) {
     if ($(this).hasClass('toggle')) return true;
+    if ($(this).find('.object_link a').length === 0) {
+      $(this).children('a.toggle').click();
+      return false;
+    }
     if (this.tagName.toLowerCase() == "li") {
       var toggle = $(this).children('a.toggle');
       if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {

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

@@ -192,11 +192,7 @@ def class_list(root = Registry.root)
       out << linkify(child, name)
       out << " &lt; #{child.superclass.name}" if child.is_a?(CodeObjects::ClassObject) && child.superclass
       out << "<small class='search_info'>"
-      if !child.namespace || child.namespace.root?
-        out << "Top Level Namespace"
-      else
-        out << child.namespace.path
-      end
+      out << child.namespace.title
       out << "</small>"
       out << "</li>"
       out << "<ul>#{class_list(child)}</ul>" if has_children

data/templates/default/layout/html/headers.erb

@@ -6,7 +6,7 @@
   <% end %>
 </title>
 <% stylesheets.each do |stylesheet| %>
-  <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" charset="utf-8" />
 <% end %>
 <%= erb :script_setup %>
 <% javascripts.each do |javascript| %>

data/templates/default/module/html/children.erb

@@ -2,7 +2,7 @@
 <p class="children">
   <% @inner.each do |name, list| %>
     <% if list.size > 0 %>
-      <strong class="<%= name %>"><%= name.to_s.capitalize %>:</strong> <%= list.map {|child| linkify(child, child.name) }.join(", ") %>
+      <strong class="<%= name %>"><%= name.to_s.capitalize %>:</strong> <%= list.map {|child| linkify(child, child.name(true)) }.join(", ") %>
     <% end %>
   <% end %>
 </p>

data/templates/default/onefile/html/headers.erb

@@ -0,0 +1,6 @@
+<style type="text/css">
+  <%= @css_data %>
+</style>
+<script type="text/javascript" charset="utf-8">
+  <%= @js_data %>
+</script>

data/templates/default/onefile/html/layout.erb

@@ -4,12 +4,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
     <title><%= @title %></title>
-    <style type="text/css" media="screen">
-      <%= @css_data %>
-    </style>
-    <script type="text/javascript" charset="utf-8">
-      <%= @js_data %>
-    </script>
+    <%= erb(:headers) %>
   </head>
   <body>
     <div id="content">

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

@@ -6,6 +6,14 @@ module OverrideFileLinks
     log.enter_level(Logger::ERROR) { result = super }
     result
   end
+
+  def url_for(object, *args)
+    if CodeObjects::ExtraFileObject === object && object == options.readme
+      'index.html'
+    else
+      super
+    end
+  end
 end
 
 Template.extra_includes << OverrideFileLinks
@@ -14,13 +22,15 @@ def init
   class << options.serializer
     def serialized_path(object)
       if CodeObjects::ExtraFileObject === object
-        super.sub(/^file\./, '')
+        super.sub(/^file\./, '').downcase
       else
         super
       end
     end
   end if options.serializer
 
+  return serialize_onefile if options.onefile
+
   generate_assets
   options.delete(:objects)
   options.files.each {|file| serialize_file(file) }
@@ -52,3 +62,12 @@ def serialize_file(file)
   end
   options.delete(:file)
 end
+
+def serialize_onefile
+  layout = Object.new.extend(T('layout'))
+  options.css_data = layout.stylesheets.map {|sheet| file(sheet,true) }.join("\n")
+  options.js_data = layout.javascripts.map {|script| file(script,true) }.join("")
+  Templates::Engine.with_serializer('onefile.html', options.serializer) do
+    T('onefile').run(options)
+  end
+end

data/templates/guide/layout/html/setup.rb

@@ -4,17 +4,21 @@ def init
   super
 
   @topfile = options.readme
-  @toptitle = options.readme.attributes[:title] || "Documentation Overview"
-  if @file == options.readme
-    @page_title = options.title
-  else
-    @page_title = @file.title
-  end
+  if options.files
+    if @topfile
+      @toptitle = @topfile.attributes[:title] || "Documentation Overview"
+    end
+    if @file == options.readme
+      @page_title = options.title
+    else
+      @page_title = @file.title
+    end
 
-  index = options.files.index(@file)
-  if index
-    @prevfile = index > 0 ? (options.files[index - 1] || options.readme) : nil
-    @nextfile = options.files[index + 1]
+    index = options.files.index(@file)
+    if index
+      @prevfile = index > 0 ? (options.files[index - 1] || options.readme) : nil
+      @nextfile = options.files[index + 1]
+    end
   end
 end
 

data/templates/guide/onefile/html/files.erb

@@ -0,0 +1,4 @@
+<% @files.each do |file| %>
+  <% @file = file %>
+  <%= diskfile %>
+<% end %>

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

@@ -0,0 +1,5 @@
+include T('default/onefile/html')
+
+def init
+  sections :layout, [:toc, :files]
+end

data/templates/guide/onefile/html/toc.erb

@@ -0,0 +1,3 @@
+<h1><%= @title %></h1>
+<h2>Table of Contents</h2>
+<div id="toc" class="one-file"></div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.8.5.2
+  version: 0.8.6
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2013-04-13 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -53,11 +53,13 @@ files:
 - lib/yard/cli/command_parser.rb
 - lib/yard/cli/config.rb
 - lib/yard/cli/diff.rb
+- lib/yard/cli/display.rb
 - lib/yard/cli/gems.rb
 - lib/yard/cli/graph.rb
 - lib/yard/cli/help.rb
 - lib/yard/cli/i18n.rb
 - lib/yard/cli/list.rb
+- lib/yard/cli/markup_types.rb
 - lib/yard/cli/server.rb
 - lib/yard/cli/stats.rb
 - lib/yard/cli/yardoc.rb
@@ -226,6 +228,7 @@ files:
 - lib/yard/templates/helpers/filter_helper.rb
 - lib/yard/templates/helpers/html_helper.rb
 - lib/yard/templates/helpers/html_syntax_highlight_helper.rb
+- lib/yard/templates/helpers/markup/rdoc_markdown.rb
 - lib/yard/templates/helpers/markup/rdoc_markup.rb
 - lib/yard/templates/helpers/markup_helper.rb
 - lib/yard/templates/helpers/method_helper.rb
@@ -242,11 +245,13 @@ files:
 - spec/cli/command_spec.rb
 - spec/cli/config_spec.rb
 - spec/cli/diff_spec.rb
+- spec/cli/display_spec.rb
 - spec/cli/gems_spec.rb
 - spec/cli/graph_spec.rb
 - spec/cli/help_spec.rb
 - spec/cli/i18n_spec.rb
 - spec/cli/list_spec.rb
+- spec/cli/markup_types_spec.rb
 - spec/cli/server_spec.rb
 - spec/cli/stats_spec.rb
 - spec/cli/yardoc_spec.rb
@@ -512,6 +517,7 @@ files:
 - templates/default/module/text/instance_meths_list.erb
 - templates/default/module/text/setup.rb
 - templates/default/onefile/html/files.erb
+- templates/default/onefile/html/headers.erb
 - templates/default/onefile/html/layout.erb
 - templates/default/onefile/html/readme.erb
 - templates/default/onefile/html/setup.rb
@@ -543,6 +549,9 @@ files:
 - templates/guide/module/html/header.erb
 - templates/guide/module/html/method_list.erb
 - templates/guide/module/html/setup.rb
+- templates/guide/onefile/html/files.erb
+- templates/guide/onefile/html/setup.rb
+- templates/guide/onefile/html/toc.erb
 - templates/guide/tags/html/setup.rb
 - benchmarks/builtins_vs_eval.rb
 - benchmarks/concat_vs_join.rb