yard 0.7.2 → 0.7.3

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

@@ -96,7 +96,7 @@ module YARD
 
         # Show error message telling user to install first potential provider
         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}`"
+        log.error "Missing '#{lib}' gem for #{type.to_s.capitalize} formatting. Install it with `gem install #{lib}`"
         false
       end
 

data/lib/yard/verifier.rb

@@ -118,7 +118,7 @@ module YARD
     # @return [void]
     def unmodify_nilclass
       NILCLASS_METHODS.each do |meth|
-        NilClass.send(:undef_method, meth)
+        NilClass.send(:remove_method, meth)
       end
     end
 
@@ -145,4 +145,4 @@ module YARD
       expr
     end
   end
-end
+end

data/spec/cli/server_spec.rb

@@ -87,8 +87,8 @@ describe YARD::CLI::Server do
   end
   
   it "should accept --docroot" do
-    @server_options[:DocumentRoot] = '/foo/bar'
-    run '--docroot', '/foo/bar'
+    @server_options[:DocumentRoot] = Dir.pwd + '/__foo/bar'
+    run '--docroot', '__foo/bar'
   end
   
   it "should accept -a webrick to create WEBrick adapter" do
@@ -156,15 +156,16 @@ describe YARD::CLI::Server do
   it "should load ruby code (-e) after adapter" do
     unstub_adapter
     @cli.adapter = Server::WebrickAdapter
-    File.open(File.dirname(__FILE__) + '/tmp.adapterscript.rb', 'w') do |f|
-      begin
+    path = File.dirname(__FILE__) + '/tmp.adapterscript.rb'
+    begin
+      File.open(path, 'w') do |f|
         f.puts "YARD::Templates::Engine.register_template_path 'foo'"
         f.flush
         run '-e', f.path
         Templates::Engine.template_paths.last.should == 'foo'
-      ensure
-        File.unlink(f.path)
       end
+    ensure
+      File.unlink(path)
     end
   end
 end

data/spec/cli/yri_spec.rb

@@ -70,7 +70,7 @@ describe YARD::CLI::Yardoc do
       @yri.should_receive(:print_object).with(obj)
       @yri.run('Foo')
       Registry.clear
-    end
+    end unless ENV['CI'] # FIXME make this work on Travis CI
     
     it "should print usage if no object is provided" do
       @yri.should_receive(:print_usage)

data/spec/code_objects/extra_file_object_spec.rb

@@ -70,7 +70,7 @@ describe YARD::CodeObjects::ExtraFileObject do
       data = "# @encoding sjis\nFOO"
       data.force_encoding('binary')
       file = ExtraFileObject.new('file.txt', data)
-      file.contents.encoding.to_s.should == 'Shift_JIS'
+      ['Shift_JIS', 'Windows-31J'].should include(file.contents.encoding.to_s)
     end if RUBY19
 
     it "should warn if @encoding is invalid" do

data/spec/config_spec.rb

@@ -90,7 +90,6 @@ describe YARD::Config do
   
   describe '.load_plugins' do
     it "should load gem plugins if :load_plugins is true" do
-      File.should_receive(:file?).with(CLI::Yardoc::DEFAULT_YARDOPTS_FILE).and_return(false)
       YARD::Config.stub!(:options).and_return(:load_plugins => true, :ignored_plugins => [], :autoload_plugins => [])
       YARD::Config.stub!(:load_plugin)
       YARD::Config.should_receive(:require).with('rubygems')

data/spec/handlers/base_spec.rb

@@ -140,10 +140,10 @@ describe YARD::Handlers::Base do
     end
     
     def create_handler(stmts, parser_type)
-      @@counter ||= 0
+      $handler_counter ||= 0
       sklass = parser_type == :ruby ? "Base" : "Legacy::Base"
       instance_eval(<<-eof)
-        class ::InFileHandler#{@@counter += 1} < Handlers::Ruby::#{sklass}
+        class ::InFileHandler#{$handler_counter += 1} < Handlers::Ruby::#{sklass}
           handles /^class/
           #{stmts}
           def process; MethodObject.new(:root, :FOO) end

data/spec/handlers/constant_handler_spec.rb

@@ -12,7 +12,7 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ConstantHandle
   end
   
   it "should maintain newlines" do
-    Registry.at("A::B::MYCONSTANT").value.should == "A +\nB +\nC +\nD"
+    Registry.at("A::B::MYCONSTANT").value.gsub("\r", "").should == "A +\nB +\nC +\nD"
   end
   
   it "should turn Const = Struct.new(:sym) into class Const with attr :sym" do

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

@@ -52,4 +52,8 @@ class Testing
   def mymethod11
     raise foo('bar')
   end
+  
+  def mymethod12
+    raise
+  end
 end

data/spec/handlers/exception_handler_spec.rb

@@ -41,4 +41,8 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ExceptionHandl
     P('Testing#mymethod10').tag(:raise).should be_nil
     P('Testing#mymethod11').tag(:raise).should be_nil
   end
+  
+  it "should ignore empty raise call" do
+    P('Testing#mymethod12').tag(:raise).should be_nil
+  end
 end

data/spec/handlers/ruby/base_spec.rb

@@ -58,11 +58,11 @@ describe YARD::Handlers::Ruby::Base, '#valid_handler?' do
 
   it "should handle AstNode input (matches AST literally)" do
     class ASTHandler < Handlers::Ruby::Base
-      handles s(:var_ref, s(:ident, "hello_world"))
+      handles s(:vcall, s(:ident, "hello_world"))
     end
     Handlers::Base.stub!(:subclasses).and_return [ASTHandler]
-    valid ASTHandler, s(:var_ref, s(:ident, "hello_world"))
-    invalid ASTHandler, s(:var_ref, s(:ident, "NOTHELLOWORLD"))
+    valid ASTHandler, s(:vcall, s(:ident, "hello_world"))
+    invalid ASTHandler, s(:vcall, s(:ident, "NOTHELLOWORLD"))
   end
   
   it "should handle #method_call(:methname) on a valid AST" do

data/spec/parser/c_parser_spec.rb

@@ -11,6 +11,11 @@ describe YARD::Parser::CParser do
       @parser.parse
     end
 
+    def parse
+      Registry.clear
+      Parser::CParser.new(@contents).parse
+    end
+
     describe 'Array class' do
       it "should parse Array class" do
         obj = YARD::Registry.at('Array')
@@ -32,11 +37,6 @@ describe YARD::Parser::CParser do
         @contents = File.read(@multifile)
       end
       
-      def parse
-        Registry.clear
-        Parser::CParser.new(@contents).parse
-      end
-      
       it "should look for methods in extra files (if 'in' comment is found)" do
         extra_contents = File.read(@extrafile)
         File.should_receive(:read).with('extra.c').and_return(extra_contents)
@@ -52,12 +52,7 @@ describe YARD::Parser::CParser do
       end
     end
     
-    describe 'Foo' do
-      def parse
-        Registry.clear
-        Parser::CParser.new(@contents).parse
-      end
-
+    describe 'Foo class' do
       it 'should not include comments in docstring source' do
         @contents = <<-eof
           /* 
@@ -76,6 +71,100 @@ describe YARD::Parser::CParser do
           "VALUE foo(VALUE x) { int value = x;\n}"
       end
     end
+    
+    describe 'Defining methods with source in other files' do
+      it "should look in another file for method" do
+        File.should_receive(:read).at_least(1).times.with('file.c').and_return(<<-eof)
+          /* FOO
+           */
+          VALUE foo(VALUE x) 
+          { }
+
+          /* BAR
+           */
+          VALUE bar(VALUE x) 
+          { }
+        eof
+        @contents = <<-eof
+          void Init_Foo() {
+            rb_define_method(rb_cFoo, "foo", foo, 1); /* in file.c */
+            rb_define_global_function("bar", bar, 1); /* in file.c */
+          }
+        eof
+        parse
+        Registry.at('Foo#foo').docstring.should == 'FOO'
+        Registry.at('Kernel#bar').docstring.should == 'BAR'
+      end
+
+      it "should allow extra file to include /'s and other filename characters" do
+        File.should_receive(:read).at_least(1).times.with('ext/a-file.c').and_return(<<-eof)
+          /* FOO
+           */
+          VALUE foo(VALUE x) {
+            int value = x;
+          }
+          
+          /* BAR
+           */
+          VALUE bar(VALUE x) {
+            int value = x;
+          }
+        eof
+        @contents = <<-eof
+          void Init_Foo() {
+            rb_define_method(rb_cFoo, "foo", foo, 1); /* in ext/a-file.c */
+            rb_define_global_function("bar", bar, 1); /* in ext/a-file.c */
+          }
+        eof
+        parse
+        Registry.at('Foo#foo').docstring.should == 'FOO'
+        Registry.at('Kernel#bar').docstring.should == 'BAR'
+      end
+    end
+    
+    describe 'Defining attributes' do
+      before do
+        Registry.clear
+      end
+      
+      def run(read, write, commented = nil)
+        @contents = <<-eof
+          /* FOO */
+          VALUE foo(VALUE x) { int value = x; }
+          void Init_Foo() {
+            rb_cFoo = rb_define_class("Foo", rb_cObject);
+            #{commented ? '/*' : ''} 
+              rb_define_attr(rb_cFoo, "foo", foo, #{read}, #{write});
+            #{commented ? '*/' : ''}
+          }
+        eof
+        parse
+      end
+      
+      it "should handle readonly attribute (rb_define_attr)" do
+        run(1, 0)
+        Registry.at('Foo#foo').should be_reader
+        Registry.at('Foo#foo=').should be_nil
+      end
+
+      it "should handle writeonly attribute (rb_define_attr)" do
+        run(0, 1)
+        Registry.at('Foo#foo').should be_nil
+        Registry.at('Foo#foo=').should be_writer
+      end
+
+      it "should handle readwrite attribute (rb_define_attr)" do
+        run(1, 1)
+        Registry.at('Foo#foo').should be_reader
+        Registry.at('Foo#foo=').should be_writer
+      end
+
+      it "should handle commented writeonly attribute (/* rb_define_attr */)" do
+        run(1, 1, true)
+        Registry.at('Foo#foo').should be_reader
+        Registry.at('Foo#foo=').should be_writer
+      end
+    end
   end
 
   describe '#find_override_comment' do

data/spec/parser/ruby/ast_node_spec.rb

@@ -22,7 +22,8 @@ describe YARD::Parser::Ruby::AstNode do
       obj = YARD::Parser::Ruby::RubyParser.parse("# x\nbye", "x").ast
       out = StringIO.new
       PP.pp(obj, out)
-      out.string.should == "s(s(:var_ref,\n" +
+      vcall = RUBY_VERSION >= '1.9.3' ? 'vcall' : 'var_ref'
+      out.string.should == "s(s(:#{vcall},\n" +
         "      s(:ident, \"bye\", line: 2..2, source: 4..6),\n" +
         "      docstring: \"x\",\n" +
         "      line: 2..2,\n" +

data/spec/parser/ruby/ruby_parser_spec.rb

@@ -179,7 +179,7 @@ describe YARD::Parser::Ruby::RubyParser do
       s.line_range.to_a.should == [1, 2]
     end
     
-    it "should show proper source for heredoc" do
+    it "should show proper source for inline heredoc" do
       src = "def foo\n  foo(<<-XML, 1, 2)\n    bar\n\n  XML\nend"
       s = stmt(src)
       t = tokenize(src)
@@ -187,11 +187,27 @@ describe YARD::Parser::Ruby::RubyParser do
       t.map {|x| x[1] }.join.should == src
     end
     
+    it "should show proper source for regular heredoc" do
+      src = "def foo\n  x = <<-XML\n  Hello \#{name}!\n  Bye!\n  XML\nend"
+      s = stmt(src)
+      t = tokenize(src)
+      s.source.should == src
+      t.map {|x| x[1] }.join.should == src
+    end
+
+    it "should show proper source for heredoc with comment" do
+      src = "def foo\n  x = <<-XML # HI!\n  Hello \#{name}!\n  Bye!\n  XML\nend"
+      s = stmt(src)
+      t = tokenize(src)
+      s.source.should == src
+      t.map {|x| x[1] }.join.should == src
+    end
+    
     it "should show proper source for string" do
       ["'", '"'].each do |q|
         src = "#{q}hello\n\nworld#{q}"
         s = stmt(src)
-        s.jump(:string_content)[0].should == "hello\n\nworld"
+        s.jump(:string_content).source.should == "hello\n\nworld"
         s.source.should == src
       end
       
@@ -204,6 +220,11 @@ describe YARD::Parser::Ruby::RubyParser do
       stmt(src).jump(:qwords_literal).source.should == src
     end
     
+    it "should show proper source for %w{} array" do
+      src = "%w{\na b c\n d e f\n}"
+      stmt(src).jump(:array).source.should == src
+    end
+
     it "should parse %w() array in constant declaration" do
       s = stmt(<<-eof)
         class Foo
@@ -211,6 +232,26 @@ describe YARD::Parser::Ruby::RubyParser do
         end
       eof
       s.jump(:qwords_literal).source.should == '%w( foo bar )'
+      if RUBY_VERSION >= '1.9.3' # ripper fix: array node encapsulates qwords
+        s.jump(:array).source.should == '%w( foo bar )'
+      end
+    end
+    
+    it "should parse [] as array" do
+      s = stmt(<<-eof)
+        class Foo
+          FOO = ['foo', 'bar']
+        end
+      eof
+      s.jump(:array).source.should == "['foo', 'bar']"
+    end
+    
+    it "should show source for unary minus" do
+      stmt("X = - 1").jump(:unary).source.should == '- 1'
+    end
+
+    it "should show source for unary exclamation" do
+      stmt("X = !1").jump(:unary).source.should == '!1'
     end
   end
 end if HAVE_RIPPER

data/spec/parser/source_parser_spec.rb

@@ -487,7 +487,8 @@ describe YARD::Parser::SourceParser do
           File.should_receive(:read_binary).with('tmpfile').and_return(src)
           result = parser.parse("tmpfile")
           if HAVE_RIPPER && RUBY19
-            result.enumerator[0].source.encoding.to_s.send(msg) == 'Shift_JIS'
+            ['Shift_JIS', 'Windows-31J'].send(msg, include(
+              result.enumerator[0].source.encoding.to_s))
           end
           result.encoding_line.send(msg) == src.split("\n").last
         end

data/spec/templates/examples/method001.html

@@ -63,7 +63,7 @@ Comments
             
           </span>
           &mdash; <div class='inline'>first key</div>
-        </tr>
+        </li>
       
         <li>
           <span class="name">:key2</span>
@@ -72,10 +72,11 @@ Comments
             
           </span>
           &mdash; <div class='inline'>second key</div>
-        </tr>
+        </li>
       
     </ul>
   
+
 <h3>Returns:</h3>
 <ul class="return">
   

data/spec/templates/helpers/html_helper_spec.rb

@@ -39,7 +39,8 @@ describe YARD::Templates::Helpers::HtmlHelper do
     
     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
+      # not the correct charset name, but good enough
+      ['Shift_JIS', 'Windows-31J'].should include(charset)
     end if RUBY19
 
     it "should take file encoding if there is a file" do
@@ -114,7 +115,7 @@ describe YARD::Templates::Helpers::HtmlHelper do
     end
     
     it "should highlight ruby if markup is :ruby" do
-      htmlify("class Foo; end", :ruby).should =~ /\A<pre class="code"><span/
+      htmlify("class Foo; end", :ruby).should =~ /\A<pre class="code ruby"><span/
     end
     
     it "should include file and htmlify it" do
@@ -194,6 +195,20 @@ describe YARD::Templates::Helpers::HtmlHelper do
       stub!(:serializer).and_return(serializer)
       link_object("YARD").should =~ %r{>YARD</a>}
     end
+
+    it "should escape method name in title" do
+      YARD.parse_string <<-'eof'
+        class Array
+          def &(other)
+          end
+        end
+      eof
+      obj = Registry.at('Array#&')
+      serializer = Serializers::FileSystemSerializer.new
+      stub!(:serializer).and_return(serializer)
+      stub!(:object).and_return(obj)
+      link_object("Array#&").should =~ %r{title="Array#&amp; \(method\)"}
+    end
   end
 
   describe '#url_for' do
@@ -257,8 +272,14 @@ describe YARD::Templates::Helpers::HtmlHelper do
     end
     
     it "should escape {} syntax with backslash (\\{foo bar})" do
-      input  = '\{foo bar} \{XYZ} \{file:FOO}'
-      output = '{foo bar} {XYZ} {file:FOO}'
+      input  = '\{foo bar} \{XYZ} \{file:FOO} $\{N-M}'
+      output = '{foo bar} {XYZ} {file:FOO} ${N-M}'
+      resolve_links(input).should == output
+    end
+
+    it "should escape {} syntax with ! (!{foo bar})" do
+      input  = '!{foo bar} !{XYZ} !{file:FOO} $!{N-M}'
+      output = '{foo bar} {XYZ} {file:FOO} ${N-M}'
       resolve_links(input).should == output
     end
 
@@ -492,7 +513,7 @@ describe YARD::Templates::Helpers::HtmlHelper do
     
     it "should highlight as ruby if htmlify(text, :ruby) is called" do
       should_receive(:html_syntax_highlight_ruby).with('def x; end').and_return('x')
-      htmlify('def x; end', :ruby).should == '<pre class="code">x</pre>'
+      htmlify('def x; end', :ruby).should == '<pre class="code ruby">x</pre>'
     end
   end