yard 0.6.5 → 0.6.6

data/ChangeLog

@@ -1,3 +1,53 @@
+2011-04-06  Loren Segal <lsegal@soen.ca>
+
+  * ChangeLog, README.md, lib/yard.rb: 0.6.6 release
+
+  * lib/yard/templates/helpers/markup_helper.rb: Remove loading of 'rdoc' lib
+  (not all systems have even this file)
+
+2011-04-05  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/cli/yardoc.rb, lib/yard/templates/helpers/html_helper.rb,
+  lib/yard/templates/helpers/markup_helper.rb, spec/cli/yardoc_spec.rb,
+  spec/templates/helpers/html_helper_spec.rb: Add :none markup format (yard -m
+  none) to bypass markup, and fallback on this format if RDoc is not present
+  and no markup type is provided.
+
+2011-04-04  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb: Fix matching of {http://link
+  description} matches when description has newline in it.  Closes #267
+
+  * lib/yard/autoload.rb, lib/yard/templates/helpers/html_helper.rb,
+  lib/yard/templates/helpers/markup_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb,
+  spec/templates/helpers/markup_helper_spec.rb: Refactor RDoc markup into
+  Templates::Helpers::Markup::RDocMarkup class and improve early error
+  detection if RDoc is not present on the system.  Closes #270
+
+  * Rakefile, lib/yard/rubygems/specification.rb: Add support for RubyGems
+  1.7.x  Closes #272
+
+2011-03-22  Loren Segal <lsegal@soen.ca>
+
+  * benchmarks/splat_vs_flatten.rb, lib/yard/docstring.rb,
+  lib/yard/tags/overload_tag.rb: Remove hackish OverloadTag#to_a support to
+  workaround create_tag(*tags) issue (and fix support in JRuby)
+
+2011-03-17  Akzhan Abdulin <akzhan.abdulin@gmail.com>
+
+  * lib/yard/core_ext/hash.rb: Fix RDoc failure in lib/yard/core_ext/hash.rb at
+  or around line 13 column 11  Before reporting this, could you check that the
+  file you're documenting compiles cleanly--RDoc is not a full Ruby parser, and
+  gets confused easily if fed invalid programs.  The internal error was: 
+  ERROR:  While generating documentation for yard-0.6.5 ... MESSAGE:   Name or
+  symbol expected (got #<RubyToken::TkfLBRACK:0x1025e40e0>) ... RDOC args: --ri
+  --op /Users/akzhanabdulin/.rvm/gems/ree-1.8.7-2011.03/doc/yard-0.6.5/ri
+  --quiet lib --title yard-0.6.5 Documentation (continuing with the rest of the
+  installation) Installing RDoc documentation for ripper-1.0.2... Installing
+  RDoc documentation for yard-0.6.5...
+
 2011-03-13  Loren Segal <lsegal@soen.ca>
 
   * ChangeLog, LICENSE, README.md, docs/WhatsNew.md, lib/yard.rb, yard.gemspec:

data/README.md

@@ -8,8 +8,8 @@ YARD: Yay! A Ruby Documentation Tool
 **Contributors**: See Contributors section below    
 **Copyright**:    2007-2011    
 **License**:      MIT License    
-**Latest Version**: 0.6.5 (codename "Happy Birthday!")    
-**Release Date**: March 13th 2011    
+**Latest Version**: 0.6.6 (codename "No codename")    
+**Release Date**: April 6th 2011    
 
 Synopsis
 --------
@@ -289,6 +289,12 @@ More options can be seen by typing `yard-graph --help`, but here is an example:
 Changelog
 ---------
 
+- **April.6.11**: 0.6.6 release
+		- Fix error message when RDoc is not present (#270)
+		- Add markup type 'none' to perform basic HTML translation (fallback when RDoc is not present)
+		- Add support for RubyGems 1.7.x (#272)
+		- Fix rendering of `{url description}` syntax when description contains newline
+
 - **March.13.11**: 0.6.5 release
     - Support `ripper` gem in Ruby 1.8.7
     - Upgrade jQuery to 1.5.1

data/Rakefile

@@ -1,4 +1,5 @@
 require File.dirname(__FILE__) + '/lib/yard'
+require File.dirname(__FILE__) + '/lib/yard/rubygems/specification'
 require 'rbconfig'
 
 YARD::VERSION.replace(ENV['YARD_VERSION']) if ENV['YARD_VERSION']
@@ -9,7 +10,6 @@ task :default => :specs
 
 desc "Builds the gem"
 task :gem do
-  Gem.load_plugins # load plugins because they are not autoloaded anymore
   load 'yard.gemspec'
   Gem::Builder.new(SPEC).build
 end

data/benchmarks/splat_vs_flatten.rb

@@ -0,0 +1,12 @@
+require "benchmark"
+
+# To prove that flattening a small list is not significantly slower than
+# calling *list (used to get around create_tag list issue)
+$a = "FOO BAR BAZ"
+def foo(*args) args.last.inspect end
+
+TESTS = 10_000
+Benchmark.bmbm do |x|
+  x.report("splat") { TESTS.times { foo *$a } }
+  x.report("flatten") { TESTS.times { foo *[$a].flatten } }
+end

data/lib/yard.rb

@@ -1,5 +1,5 @@
 module YARD
-  VERSION = "0.6.5"
+  VERSION = "0.6.6"
   
   # The root path for YARD source libraries
   ROOT = File.expand_path(File.dirname(__FILE__))

data/lib/yard/autoload.rb

@@ -195,6 +195,10 @@ module YARD
   # Namespace for templating system
   module Templates
     module Helpers # Namespace for template helpers
+      module Markup # Namespace for markup providers
+        autoload :RDocMarkup,               __p('templates/helpers/markup/rdoc_markup')
+      end
+      
       autoload :BaseHelper,                 __p('templates/helpers/base_helper')
       autoload :FilterHelper,               __p('templates/helpers/filter_helper')
       autoload :HtmlHelper,                 __p('templates/helpers/html_helper')

data/lib/yard/cli/yardoc.rb

@@ -158,7 +158,7 @@ module YARD
         @options.update(
           :format => :html, 
           :template => :default, 
-          :markup => :rdoc,
+          :markup => nil, # default is :rdoc but falls back on :none
           :serializer => YARD::Serializers::FileSystemSerializer.new,
           :default_return => "Object",
           :hide_void_return => false,
@@ -302,9 +302,20 @@ module YARD
       # 
       # @return (see YARD::Templates::Helpers::MarkupHelper#load_markup_provider)
       def verify_markup_options
+        has_markup = options[:markup] ? true : false
+        options[:markup] ||= :rdoc
+        result, lvl = false, has_markup ? log.level : Logger::FATAL
         obj = Struct.new(:options).new(options)
         obj.extend(Templates::Helpers::MarkupHelper)
-        obj.load_markup_provider
+        log.enter_level(lvl) { result = obj.load_markup_provider }
+        if !result && !has_markup
+          log.warn "Could not load default RDoc formatter, " +
+            "ignoring any markup (install RDoc to get default formatting)."
+          options[:markup] = :none
+          true
+        else
+          result
+        end
       end
       
       # Copies any assets to the output directory

data/lib/yard/core_ext/hash.rb

@@ -9,7 +9,7 @@ class Hash
         create_186(*args)
       end
     end
-    alias create_186 []
-    alias [] create
+    alias :create_186 :[]
+    alias :[] :create
   end
 end if RUBY_VERSION < "1.8.7"

data/lib/yard/docstring.rb

@@ -199,7 +199,7 @@ module YARD
       tag_factory = Tags::Library.instance
       tag_method = "#{tag_name}_tag"
       if tag_name && tag_factory.respond_to?(tag_method)
-        add_tag(*tag_factory.send(tag_method, tag_buf))
+        add_tag(*[tag_factory.send(tag_method, tag_buf)].flatten)
       else
         log.warn "Unknown tag @#{tag_name}" + (object ? " in file `#{object.file}` near line #{object.line}" : "")
       end

data/lib/yard/rubygems/specification.rb

@@ -1,13 +1,9 @@
 require 'rubygems/specification'
 
 class Gem::Specification
-  # has_rdoc should not be ignored!
-  overwrite_accessor(:has_rdoc) { @has_rdoc }
-  overwrite_accessor(:has_rdoc=) {|v| @has_rdoc = v }
-
   # @since 0.5.3
   def has_yardoc=(value)
-    @has_rdoc = 'yard'
+    @has_rdoc = value ? 'yard' : false
   end
 
   def has_yardoc
@@ -20,4 +16,26 @@ class Gem::Specification
   end
 
   alias has_yardoc? has_yardoc
+
+  # has_rdoc should not be ignored!
+  if respond_to?(:overwrite_accessor)
+    overwrite_accessor(:has_rdoc) { @has_rdoc }
+    overwrite_accessor(:has_rdoc=) {|v| @has_rdoc = v }
+  else
+    attr_accessor :has_rdoc
+  end
+  
+  if defined?(Gem::VERSION) && Gem::VERSION =~ /^1\.7\./
+    def _dump_with_rdoc(limit)
+      dmp = _dump_without_rdoc(limit)
+      dmp[15] = @has_rdoc
+      dmp
+    end
+    alias _dump_without_rdoc _dump
+    alias _dump _dump_with_rdoc
+  
+    @@default_value[:has_rdoc] = true if defined?(@@default_value)
+    @@attributes << 'has_rdoc' if defined?(@@attributes)
+    @@non_nil_attributes << 'has_rdoc' if defined?(@@non_nil_attributes)
+  end
 end

data/lib/yard/tags/overload_tag.rb

@@ -37,11 +37,6 @@ module YARD
       alias kind_of? is_a?
       
       private
-
-      if RUBY19
-        def to_a; nil end 
-        def to_ary; nil end
-      end
       
       def parse_tag(text)
         @signature, text = *text.split(/\r?\n/, 2)

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

@@ -77,13 +77,9 @@ module YARD
       # @return [String] output HTML
       # @since 0.6.0
       def html_markup_rdoc(text)
-        begin
-          simple_markup_html.instance_variable_set("@from_path", url_for(object))
-          html = markup_class(:rdoc).new.convert(text, simple_markup_html)
-        end
-
-        html = fix_dash_dash(html)
-        html = fix_typewriter(html)
+        doc = markup_class(:rdoc).new(text)
+        doc.from_path = url_for(object) if doc.respond_to?(:from_path=)
+        doc.to_html
       end
       
       # Converts plaintext to HTML
@@ -94,6 +90,12 @@ module YARD
         "<pre>" + text + "</pre>"
       end
       
+      # @return [String] the same text with no markup
+      # @since 0.6.6
+      def html_markup_none(text)
+        h(text).gsub(/(?:\r?\n){2}/, '<br/>')
+      end
+      
       # Converts HTML to HTML
       # @param [String] text input html
       # @return [String] output HTML
@@ -107,29 +109,6 @@ module YARD
         "<div class='inline'>" + htmlify(*args) + "</div>"
       end
       
-      # Fixes RDoc behaviour with ++ only supporting alphanumeric text.
-      # 
-      # @todo Refactor into own SimpleMarkup subclass
-      def fix_typewriter(text)
-        text.gsub(/(\s|^|>)\+(?! )([^\n\+]{1,900})(?! )\+/) do
-          first_text, type_text, pre_text, no_match = $1, $2, $`, $&
-          pre_match = (pre_text+first_text).scan(%r(</?(?:(?:pre|tt|code).*?>|[^>]+)\Z))
-          if pre_match.last.nil? || pre_match.last[1,1] == '/'
-            first_text + '<tt>' + h(type_text) + '</tt>'
-          else
-            no_match
-          end
-        end
-      end
-      
-      # Don't allow -- to turn into &#8212; element. The chances of this being
-      # some --option is far more likely than the typographical meaning.
-      # 
-      # @todo Refactor into own SimpleMarkup subclass
-      def fix_dash_dash(text)
-        text.gsub(/&#8212;(?=\S)/, '--')
-      end
-      
       # @group Syntax Highlighting Source Code
       
       # Syntax highlights +source+ in language +type+.
@@ -175,7 +154,7 @@ module YARD
       # @return [String] HTML with linkified references
       def resolve_links(text)
         code_tags = 0
-        text.gsub(/<(\/)?(pre|code|tt)|\{(\S+?)(?:\s(.*?\S))?\}(?=[\W<]|.+<\/|$)/) do |str|
+        text.gsub(/<(\/)?(pre|code|tt)|\{(\S+?)(?:\s(.*?\S))?\}(?=[\W<]|.+<\/|$)/m) do |str|
           closed, tag, name, title, match = $1, $2, $3, $4, $&
           if tag
             code_tags += (closed ? -1 : 1)
@@ -235,12 +214,13 @@ module YARD
       # (see BaseHelper#link_url)
       def link_url(url, title = nil, params = {})
         title ||= url
+        title.gsub!(/[\r\n]/, ' ')
         params = SymbolHash.new(false).update(
           :href => url,
           :title  => h(title)
         ).update(params)
         params[:target] ||= '_parent' if url =~ /^(\w+):\/\//
-        "<a #{tag_attrs(params)}>#{title}</a>"
+        "<a #{tag_attrs(params)}>#{title}</a>".gsub(/[\r\n]/, ' ')
       end
       
       # @group URL Helpers
@@ -445,22 +425,7 @@ module YARD
       # @endgroup
       
       private
-      
-      # Gets the SimpleMarkup class for the local thread
-      # 
-      # @return [RDoc::Markup::ToHtml] if RDoc 2.x is loaded
-      # @return [SM::ToHtml] if RDoc 1.x is loaded
-      # @since 0.6.5
-      def simple_markup_html
-        begin
-          require 'rdoc/markup/to_html'
-        rescue LoadError
-          require 'rdoc/markup/simple_markup/to_html' 
-        end
-        Thread.current[:__yard_simple_markup_html__] ||= 
-          (RDoc::Markup::ToHtml.new rescue SM::ToHtml.new)
-      end
-      
+
       # Converts a set of hash options into HTML attributes for a tag
       # 
       # @param [Hash{String => String}] opts the tag options

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

@@ -0,0 +1,80 @@
+module YARD
+  module Templates
+    module Helpers
+      module Markup
+        begin
+          require 'rdoc/markup'
+          require 'rdoc/markup/to_html'
+          class RDocMarkup; MARKUP = RDoc::Markup end
+          class RDocMarkupToHtml < RDoc::Markup::ToHtml; end
+        rescue LoadError
+          begin
+            require 'rdoc/markup/simple_markup'
+            require 'rdoc/markup/simple_markup/to_html'
+            class RDocMarkup; MARKUP = SM::SimpleMarkup end
+            class RDocMarkupToHtml < SM::ToHtml; end
+          rescue LoadError
+            raise NameError, "could not load RDocMarkup (rdoc is not installed)"
+          end
+        end
+        
+        class RDocMarkup
+          attr_accessor :from_path
+          
+          def initialize(text)
+            @text = text
+            @markup = MARKUP.new
+          end
+          
+          def to_html
+            formatter = RDocMarkupToHtml.new
+            formatter.from_path = from_path
+            html = @markup.convert(@text, formatter)
+            html = fix_dash_dash(html)
+            html = fix_typewriter(html)
+            html
+          end
+          
+          private
+
+          # Fixes RDoc behaviour with ++ only supporting alphanumeric text.
+          # 
+          # @todo Refactor into own SimpleMarkup subclass
+          def fix_typewriter(text)
+            text.gsub(/(\s|^|>)\+(?! )([^\n\+]{1,900})(?! )\+/) do
+              first_text, type_text, pre_text, no_match = $1, $2, $`, $&
+              pre_match = (pre_text+first_text).scan(%r(</?(?:(?:pre|tt|code).*?>|[^>]+)\Z))
+              if pre_match.last.nil? || pre_match.last[1,1] == '/'
+                first_text + '<tt>' + CGI.escapeHTML(type_text) + '</tt>'
+              else
+                no_match
+              end
+            end
+          end
+
+          # Don't allow -- to turn into &#8212; element. The chances of this being
+          # some --option is far more likely than the typographical meaning.
+          # 
+          # @todo Refactor into own SimpleMarkup subclass
+          def fix_dash_dash(text)
+            text.gsub(/&#8212;(?=\S)/, '--')
+          end
+        end
+        
+        class RDocMarkupToHtml
+          attr_accessor :from_path
+          
+          # Disable auto-link of URLs
+          def handle_special_HYPERLINK(special)
+            @hyperlink ? special.text : super
+          end
+          
+          def accept_paragraph(par)
+            @hyperlink = !!(par.text =~ /\{(https?:|mailto:|link:|www\.)/)
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,11 +32,11 @@ module YARD
           {:lib => :redcloth, :const => 'RedCloth'}
         ],
         :rdoc => [
-          {:lib => 'rdoc/markup', :const => 'RDoc::Markup'},
-          {:lib => 'rdoc/markup/simple_markup', :const => 'SM::SimpleMarkup'}
+          {:lib => nil, :const => 'YARD::Templates::Helpers::Markup::RDocMarkup'},
         ],
         :text => [],
-        :html => []
+        :html => [],
+        :none => []
       }
       
       # Returns a list of extensions for various markup types. To register
@@ -48,7 +48,7 @@ module YARD
         :text => ['txt'],
         :textile => ['textile', 'txtile'],
         :markdown => ['markdown', 'md', 'mdown', 'mkd'],
-        :rdoc => ['rdoc']
+        :rdoc => ['rdoc'],
       }
       
       # Contains the Regexp object that matches the shebang line of extra
@@ -84,7 +84,7 @@ module YARD
         
         # Search for provider, return the library class name as const if found
         providers.each do |provider|
-          begin require provider[:lib].to_s; rescue LoadError; next end
+          begin require provider[:lib].to_s; rescue LoadError; next end if provider[:lib]
           begin klass = eval("::" + provider[:const]); rescue NameError; next end
           MarkupHelper.markup_cache[type][:provider] = provider[:lib] # Cache the provider
           MarkupHelper.markup_cache[type][:class] = klass
@@ -92,8 +92,8 @@ module YARD
         end
         
         # Show error message telling user to install first potential provider
-        name, lib = providers.first[:const], providers.first[:lib]
-        log.error "Missing #{name} gem for #{options[:markup].to_s.capitalize} formatting. Install it with `gem install #{lib}`"
+        name, lib = *[providers.first[:const], providers.first[:lib] || type]
+        log.error "Missing '#{lib}' gem for #{options[:markup].to_s.capitalize} formatting. Install it with `gem install #{lib}`"
         false
       end
       

data/spec/cli/yardoc_spec.rb

@@ -44,8 +44,8 @@ describe YARD::CLI::Yardoc do
       @yardoc.files.should == ['lib/**/*.rb', 'ext/**/*.c']
     end
     
-    it "should use rdoc as default markup type" do
-      @yardoc.options[:markup].should == :rdoc
+    it "should be nil as default markup type (but defaults to rdoc and falls back on none)" do
+      @yardoc.options[:markup].should == nil
     end
     
     it "should use default as default template" do
@@ -517,4 +517,22 @@ describe YARD::CLI::Yardoc do
       @yardoc.run('--template-path', 'foo')
     end
   end
+  
+  describe 'Markup Loading' do
+    it "should load rdoc markup if no markup is provided" do
+      @yardoc.generate = true
+      @yardoc.run
+      @yardoc.options[:markup].should == :rdoc
+    end
+    
+    it "should warn if rdoc cannot be loaded and fallback to :none" do
+      mod = YARD::Templates::Helpers::MarkupHelper
+      mod.clear_markup_cache
+      mod.const_get(:MARKUP_PROVIDERS).should_receive(:[]).with(:rdoc).and_return([{:lib => 'INVALID'}])
+      log.should_receive(:warn).with(/Could not load default RDoc formatter/)
+      @yardoc.generate = true
+      @yardoc.run
+      @yardoc.options[:markup].should == :none
+    end
+  end
 end

data/spec/templates/helpers/html_helper_spec.rb

@@ -14,39 +14,6 @@ describe YARD::Templates::Helpers::HtmlHelper do
     end
   end
   
-  describe '#fix_typewriter' do
-    it "should use #fix_typewriter to convert +text+ to <tt>text</tt>" do
-      fix_typewriter("Some +typewriter text+.").should == 
-        "Some <tt>typewriter" +
-        " text</tt>."
-      fix_typewriter("Not +typewriter text.").should == 
-        "Not +typewriter text."
-      fix_typewriter("Alternating +type writer+ text +here+.").should == 
-        "Alternating <tt>type writer" +
-        "</tt> text <tt>here</tt>."
-      fix_typewriter("No ++problem.").should == 
-        "No ++problem."
-      fix_typewriter("Math + stuff +is ok+").should == 
-        "Math + stuff <tt>is ok</tt>"
-      fix_typewriter("Hello +{Foo}+ World").should == "Hello <tt>{Foo}</tt> World"
-    end
-    
-    it "should not apply to code blocks" do
-      fix_typewriter("<code>+hello+</code>").should == "<code>+hello+</code>"
-    end
-    
-    it "should not apply to HTML tag attributes" do
-      fix_typewriter("<a href='http://foo.com/A+b+c'>A+b+c</a>").should == 
-        "<a href='http://foo.com/A+b+c'>A+b+c</a>"
-      fix_typewriter("<foo class='foo+bar+baz'/>").should == 
-        "<foo class='foo+bar+baz'/>"
-    end
-    
-    it "should still apply inside of other tags" do
-      fix_typewriter("<p>+foo+</p>").should == "<p><tt>foo</tt></p>"
-    end
-  end
-  
   describe '#charset' do
     it "should return foo if LANG=foo" do
       ENV.should_receive(:[]).with('LANG').and_return('shift_jis') if RUBY18
@@ -122,6 +89,10 @@ describe YARD::Templates::Helpers::HtmlHelper do
       htmlify("\xB0\xB1", :text)
       # TODO: add more encoding tests
     end
+    
+    it "should return regular text with :none markup" do
+      htmlify("fo\no\n\nbar<>", :none).should == "fo\no<br/>bar&lt;&gt;"
+    end
   end
   
   describe "#link_object" do
@@ -229,10 +200,9 @@ describe YARD::Templates::Helpers::HtmlHelper do
   describe '#resolve_links' do
     def parse_link(link)
       results = {}
-      link =~ /<a (.+?)>(.+?)<\/a>/
+      link =~ /<a (.+?)>(.+?)<\/a>/m
       params, results[:inner_text] = $1, $2
-      params.split(/\s+/).each do |match|
-        key, value = *match.split('=')
+      params.scan(/\s*(\S+?)=['"](.+?)['"]\s*/).each do |key, value|
         results[key.to_sym] = value.gsub(/^["'](.+)["']$/, '\1')
       end
       results
@@ -294,6 +264,25 @@ describe YARD::Templates::Helpers::HtmlHelper do
         resolve_links(text).should == text
       end
     end
+
+    it "should resolve {Name}" do
+      should_receive(:link_file).with('TEST', 'TEST', nil).and_return('')
+      resolve_links("{file:TEST}")
+    end
+
+    it "should resolve ({Name})" do
+      should_receive(:link_file).with('TEST', 'TEST', nil).and_return('')
+      resolve_links("({file:TEST})")
+    end
+    
+    it "should resolve link with newline in title-part" do
+      parse_link(resolve_links("{http://example.com foo\nbar}")).should == {
+        :inner_text => "foo bar",
+        :target => "_parent",
+        :href => "http://example.com",
+        :title => "foo bar"
+      }
+    end
     
     it "should warn about missing reference at right file location for object" do
       YARD.parse_string <<-eof
@@ -427,18 +416,6 @@ describe YARD::Templates::Helpers::HtmlHelper do
     end
   end
   
-  describe '#resolve_links' do
-    it "should resolve {Name}" do
-      should_receive(:link_file).with('TEST', 'TEST', nil).and_return('')
-      resolve_links("{file:TEST}")
-    end
-
-    it "should resolve ({Name})" do
-      should_receive(:link_file).with('TEST', 'TEST', nil).and_return('')
-      resolve_links("({file:TEST})")
-    end
-  end
-  
   describe '#link_url' do
     it "should add target if scheme is provided" do
       link_url("http://url.com").should include(" target=\"_parent\"")

data/spec/templates/helpers/markup/rdoc_markup_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe YARD::Templates::Helpers::Markup::RDocMarkup do
+  describe 'loading mechanism' do
+    before { @good_libs = [] }
+    
+    def require(lib)
+      return true if @good_libs.include?(lib)
+      raise LoadError
+    end
+    
+    def load_markup
+      begin
+        require 'rdoc/markup'
+        require 'rdoc/markup/to_html'
+        return :RDoc2
+      rescue LoadError
+        begin
+          require 'rdoc/markup/simple_markup'
+          require 'rdoc/markup/simple_markup/to_html'
+          return :RDoc1
+        rescue LoadError
+          raise NameError, "could not load RDocMarkup (rdoc is not installed)"
+        end
+      end
+    end
+    
+    it "should load RDoc2.x if rdoc/markup is present" do
+      @good_libs += ['rdoc/markup', 'rdoc/markup/to_html']
+      load_markup.should == :RDoc2
+    end
+    
+    it "should fail on RDoc2.x if rdoc/markup/to_html is not present" do
+      @good_libs += ['rdoc/markup']
+      lambda { load_markup }.should raise_error(NameError)
+    end
+
+    it "should load RDoc1.x if RDoc2 fails and rdoc/markup/simple_markup is present" do
+      @good_libs += ['rdoc/markup/simple_markup', 'rdoc/markup/simple_markup/to_html']
+      load_markup.should == :RDoc1
+    end
+    
+    it "should error on loading if neither lib is present" do
+      lambda { load_markup }.should raise_error(NameError)
+    end
+  end
+  
+  describe '#fix_typewriter' do
+    def fix_typewriter(text)
+      YARD::Templates::Helpers::Markup::RDocMarkup.new('').send(:fix_typewriter, text)
+    end
+
+    it "should use #fix_typewriter to convert +text+ to <tt>text</tt>" do
+      fix_typewriter("Some +typewriter text <+.").should == 
+        "Some <tt>typewriter" +
+        " text &lt;</tt>."
+      fix_typewriter("Not +typewriter text.").should == 
+        "Not +typewriter text."
+      fix_typewriter("Alternating +type writer+ text +here+.").should == 
+        "Alternating <tt>type writer" +
+        "</tt> text <tt>here</tt>."
+      fix_typewriter("No ++problem.").should == 
+        "No ++problem."
+      fix_typewriter("Math + stuff +is ok+").should == 
+        "Math + stuff <tt>is ok</tt>"
+      fix_typewriter("Hello +{Foo}+ World").should == "Hello <tt>{Foo}</tt> World"
+    end
+    
+    it "should not apply to code blocks" do
+      fix_typewriter("<code>+hello+</code>").should == "<code>+hello+</code>"
+    end
+    
+    it "should not apply to HTML tag attributes" do
+      fix_typewriter("<a href='http://foo.com/A+b+c'>A+b+c</a>").should == 
+        "<a href='http://foo.com/A+b+c'>A+b+c</a>"
+      fix_typewriter("<foo class='foo+bar+baz'/>").should == 
+        "<foo class='foo+bar+baz'/>"
+    end
+    
+    it "should still apply inside of other tags" do
+      fix_typewriter("<p>+foo+</p>").should == "<p><tt>foo</tt></p>"
+    end
+  end
+end

data/spec/templates/helpers/markup_helper_spec.rb

@@ -32,24 +32,17 @@ describe YARD::Templates::Helpers::MarkupHelper do
       @gen.markup_class.should == nil
     end
   
-    it "should load RDoc 2.x if rdoc is specified and 2.x is installed" do
-      rdoc_lib = mock(:rdoc)
+    it "should load RDocMarkup if rdoc is specified and it is installed" do
       @gen.stub!(:options).and_return({:markup => :rdoc})
-      @gen.should_receive(:eval).with('::RDoc::Markup').and_return(rdoc_lib)
-      @gen.should_receive(:require).with('rdoc/markup').and_return(true)
       @gen.load_markup_provider.should == true
-      @gen.markup_class.should == rdoc_lib
+      @gen.markup_class.should == YARD::Templates::Helpers::Markup::RDocMarkup
     end
     
-    it "should load RDoc 1.x if rdoc 1.x is installed" do
-      rdoc_lib = mock(:rdoc)
+    it "should fail if RDoc cannot be loaded" do
       @gen.stub!(:options).and_return({:markup => :rdoc})
-      @gen.should_receive(:eval).with('::RDoc::Markup').and_raise(NameError)
-      @gen.should_receive(:eval).with('::SM::SimpleMarkup').and_return(rdoc_lib)
-      @gen.should_receive(:require).with('rdoc/markup').and_return(true)
-      @gen.should_receive(:require).with('rdoc/markup/simple_markup').and_return(true)
-      @gen.load_markup_provider.should == true
-      @gen.markup_class.should == rdoc_lib
+      @gen.should_receive(:eval).with('::YARD::Templates::Helpers::Markup::RDocMarkup').and_raise(NameError)
+      @gen.load_markup_provider.should == false
+      @gen.markup_provider.should == nil
     end
   
     it "should search through available markup providers for the markup type if none is set" do

metadata

@@ -2,7 +2,7 @@
 name: yard
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors: 
 - Loren Segal
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-13 00:00:00 -05:00
-default_executable: 
+date: 2011-04-06 00:00:00 Z
 dependencies: []
 
 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"
@@ -186,6 +185,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_markup.rb
 - lib/yard/templates/helpers/markup_helper.rb
 - lib/yard/templates/helpers/method_helper.rb
 - lib/yard/templates/helpers/module_helper.rb
@@ -329,6 +329,7 @@ files:
 - spec/templates/helpers/base_helper_spec.rb
 - spec/templates/helpers/html_helper_spec.rb
 - spec/templates/helpers/html_syntax_highlight_helper_spec.rb
+- spec/templates/helpers/markup/rdoc_markup_spec.rb
 - spec/templates/helpers/markup_helper_spec.rb
 - spec/templates/helpers/method_helper_spec.rb
 - spec/templates/helpers/shared_signature_examples.rb
@@ -459,6 +460,7 @@ files:
 - benchmarks/rdoc_vs_yardoc.rb
 - benchmarks/ri_vs_yri.rb
 - benchmarks/ripper_parser.rb
+- benchmarks/splat_vs_flatten.rb
 - benchmarks/template_erb.rb
 - benchmarks/template_format.rb
 - benchmarks/template_profile.rb
@@ -469,7 +471,6 @@ files:
 - README.md
 - Rakefile
 - .yardopts
-has_rdoc: yard
 homepage: http://yardoc.org
 licenses: []
 
@@ -493,9 +494,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yard
-rubygems_version: 1.5.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Documentation tool for consistent and usable documentation in Ruby.
 test_files: []
 
+has_rdoc: yard