yard 0.2.3.3 → 0.2.3.4

data/README.markdown

@@ -1,4 +1,4 @@
-YARD Release 0.2.3.3 (July 26th 2009)
+YARD Release 0.2.3.4 (August 7th 2009)
 =====================================
 
 **Homepage**:  [http://yard.rubyforge.org](http://yard.rubyforge.org)   

data/Rakefile

@@ -26,6 +26,7 @@ desc "Run all specs"
 Spec::Rake::SpecTask.new("specs") do |t|
   $DEBUG = true if ENV['DEBUG']
   t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_opts += ["--require", File.join(File.dirname(__FILE__), 'spec', 'spec_helper')]
   t.spec_files = Dir["spec/**/*_spec.rb"].sort
   t.rcov = true if ENV['RCOV']
   t.rcov_opts = ['-x', '_spec\.rb$,spec_helper\.rb$']

data/lib/rubygems_plugin.rb

@@ -14,6 +14,7 @@ class Gem::Specification
     @has_rdoc == 'yard'
   end
   
+  undef has_rdoc? # redefining
   def has_rdoc?
     @has_rdoc && @has_rdoc != 'yard'
   end
@@ -53,6 +54,7 @@ class Gem::DocManager
     Dir.chdir(old_pwd)
   end
 
+  undef setup_rdoc # redefining
   def setup_rdoc
     if File.exist?(@doc_dir) && !File.writable?(@doc_dir) then
       raise Gem::FilePermissionError.new(@doc_dir)
@@ -77,9 +79,9 @@ class Gem::DocManager
     @@install_ri_yard_orig.bind(self).call if @spec.has_rdoc?
   end
   @@install_ri_yard_orig = instance_method(:install_ri)
+  undef install_ri # redefining
   alias install_ri install_ri_yard
   
-  
   def install_rdoc_yard
     if @spec.has_rdoc?
       @@install_rdoc_yard_orig.bind(self).call
@@ -88,5 +90,6 @@ class Gem::DocManager
     end
   end
   @@install_rdoc_yard_orig = instance_method(:install_rdoc)
+  undef install_rdoc # redefining
   alias install_rdoc install_rdoc_yard
 end

data/lib/yard.rb

@@ -1,5 +1,5 @@
 module YARD
-  VERSION = "0.2.3.3"
+  VERSION = "0.2.3.4"
   ROOT = File.dirname(__FILE__)
   TEMPLATE_ROOT = File.join(File.dirname(__FILE__), '..', 'templates')
   
@@ -7,6 +7,9 @@ module YARD
   def self.parse_string(*args) Parser::SourceParser.parse_string(*args) end
 end
 
+# Ruby 1.9.2 removes '.' which is not exactly a good idea
+$LOAD_PATH.push('.') if RUBY_VERSION >= '1.9.2'
+
 # Keep track of Ruby version for compatibility code
 RUBY19, RUBY18 = *(RUBY_VERSION >= "1.9" ? [true, false] : [false, true])
 

data/lib/yard/autoload.rb

@@ -124,10 +124,10 @@ module YARD
       end
 
       autoload :AstNode,           __p('parser/ruby/ast_node')
-      autoload :ParserSyntaxError, __p('parser/ruby/ruby_parser')
       autoload :RubyParser,        __p('parser/ruby/ruby_parser')
     end
 
+    autoload :ParserSyntaxError,   __p('parser/source_parser')
     autoload :SourceParser,        __p('parser/source_parser')
     autoload :UndocumentableError, __p('parser/source_parser')
   end

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

@@ -28,6 +28,8 @@ module YARD
             end
           end
         end
+        
+        private
       
         # The string value of a token. For example, the return value for the symbol :sym 
         # would be :sym. The return value for a string "foo #{bar}" would be the literal 

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

@@ -3,8 +3,6 @@ require 'ripper'
 module YARD
   module Parser
     module Ruby
-      class ParserSyntaxError < UndocumentableError; end
-      
       class RubyParser < Ripper
         attr_reader :ast, :charno, :comments, :file, :tokens
         alias root ast
@@ -59,7 +57,7 @@ module YARD
           :for => "for",
           :hash => :lbrace,
           :if => "if",
-          :lambda => "lambda",
+          :lambda => [:tlambda, "lambda"],
           :module => "module",
           :next => "next",
           :paren => :lparen,
@@ -234,6 +232,10 @@ module YARD
           visit_event_arr AstNode.new(:string_literal, args)
         end
         
+        def on_lambda(*args)
+          visit_event_arr AstNode.new(:lambda, args)
+        end
+        
         def on_string_content(*args)
           AstNode.new(:string_content, args, listline: lineno..lineno, listchar: charno..charno)
         end

data/lib/yard/parser/source_parser.rb

@@ -4,6 +4,7 @@ require 'continuation' unless RUBY18
 module YARD
   module Parser
     class UndocumentableError < Exception; end
+    class ParserSyntaxError < UndocumentableError; end
     class LoadOrderError < Exception; end
     
     # Responsible for parsing a source file into the namespace
@@ -84,6 +85,10 @@ module YARD
         @parser = parse_statements(content)
         post_process
         @parser
+      rescue ArgumentError, NotImplementedError => e
+        log.warn("Cannot parse `#{file}': #{e.message}")
+      rescue ParserSyntaxError => e
+        log.warn(e.message.capitalize)
       end
       
       def tokenize(content)

data/spec/code_objects/class_object_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe YARD::CodeObjects::ClassObject do
-  before do 
+  before(:all) do 
     Registry.clear 
     @mixin = ModuleObject.new(:root, :SomeMixin)
     @mixin2 = ModuleObject.new(:root, :SomeMixin2)
@@ -27,7 +27,7 @@ describe YARD::CodeObjects::ClassObject do
 end
 
 describe YARD::CodeObjects::ClassObject, "#meths / #inherited_meths" do
-  before do 
+  before(:all) do 
     Registry.clear 
     
     Parser::SourceParser.parse_string <<-eof
@@ -89,7 +89,7 @@ describe YARD::CodeObjects::ClassObject, "#meths / #inherited_meths" do
 end
 
 describe YARD::CodeObjects::ClassObject, "#constants / #inherited_constants" do
-  before do 
+  before(:all) do 
     Registry.clear 
     
     Parser::SourceParser.parse_string <<-eof

data/spec/handlers/alias_handler_spec.rb

@@ -1,18 +1,15 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}AliasHandler" do
-  before do
-    Registry.clear 
-    parse_file :alias_handler_001, __FILE__
-  end
+  before(:all) { parse_file :alias_handler_001, __FILE__ }
 
   it "should throw alias into namespace object list" do
     P(:A).aliases[P("A#b")].should == :a
   end
   
-  it "should handle the Ruby 'alias' keyword syntax" do
-    ['A#c', 'A#d?', 'A#[]', 'A#[]=', 'A#-@', 'A#%', 'A#*'].each do |a|
-      P(a).should be_instance_of(CodeObjects::MethodObject)
+  ['c', 'd?', '[]', '[]=', '-@', '%', '*'].each do |a|
+    it "should handle the Ruby 'alias' keyword syntax for method ##{a}" do
+      P('A#' + a).should be_instance_of(CodeObjects::MethodObject)
     end
   end
   

data/spec/handlers/attribute_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}AttributeHandler" do
-  before { parse_file :attribute_handler_001, __FILE__ }
+  before(:all) { parse_file :attribute_handler_001, __FILE__ }
   
   def read_write(namespace, name, read, write, scope = :instance)
     rname, wname = namespace.to_s+"#"+name.to_s, namespace.to_s+"#"+name.to_s+"="

data/spec/handlers/class_condition_handler_spec.rb

@@ -1,10 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassConditionHandler" do
-  before do
-    Registry.clear 
-    parse_file :class_condition_handler_001, __FILE__
-  end
+  before(:all) { parse_file :class_condition_handler_001, __FILE__ }
   
   def verify_method(*names)
     names.each {|name| Registry.at("A##{name}").should_not be_nil }

data/spec/handlers/class_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassHandler" do
-  before { parse_file :class_handler_001, __FILE__ }
+  before(:all) { parse_file :class_handler_001, __FILE__ }
   
   it "should parse a class block with docstring" do
     P("A").docstring.should == "Docstring"
@@ -36,12 +36,6 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassHandler" do
     P('B::A').superclass.should == P('A')
   end
 
-  it "should raise an UndocumentableError if the class is invalid" do
-    ["CallMethod('test')", "VSD^#}}", 'not.aclass', 'self'].each do |klass|
-      undoc_error "class #{klass}; end"
-    end
-  end
-  
   it "should handle class definitions in the form ::ClassName" do
     Registry.at("MyRootClass").should_not be_nil
   end
@@ -65,15 +59,32 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassHandler" do
     P('Q::Logger').superclass.should == P(:Logger)
   end
   
-  it "should raise an UndocumentableError if the superclass is invalid but it should create the class." do
-    ['@@INVALID', 'hi', '$MYCLASS', 'AnotherClass.new'].each do |klass|
-      Registry.clear
-      undoc_error "class A < #{klass}; end"
-      Registry.at('A').should_not be_nil
+  ["CallMethod('test')", "VSD^#}}", 'not.aclass', 'self'].each do |klass|
+    it "should raise an UndocumentableError for invalid class '#{klass}'" do
+      with_parser(:ruby18) { undoc_error "class #{klass}; end" }
+    end
+  end
+  
+  ['@@INVALID', 'hi', '$MYCLASS', 'AnotherClass.new'].each do |klass|
+    it "should raise an UndocumentableError for invalid superclass '#{klass}' but it should create the class." do
+      YARD::CodeObjects::ClassObject.should_receive(:new).with(Registry.root, 'A')
+      with_parser(:ruby18) { undoc_error "class A < #{klass}; end" }
       Registry.at('A').superclass.should == P(:Object)
     end
   end
   
+  ['not.aclass', 'self', 'AnotherClass.new'].each do |klass|
+    it "should raise an UndocumentableError if the constant class reference 'class << SomeConstant' does not point to a valid class name" do
+      with_parser(:ruby18) do
+        undoc_error <<-eof
+          CONST = #{klass}
+          class << CONST; end
+        eof
+      end
+      Registry.at(klass).should be_nil
+    end
+  end
+
   it "should document 'class << SomeConstant' by using SomeConstant's value as a reference to the real class name" do
     Registry.at('String.classmethod').should_not be_nil
   end
@@ -82,17 +93,6 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassHandler" do
     Registry.at('Symbol.toString').should_not be_nil
   end
   
-  it "should raise an UndocumentableError if the constant class reference 'class << SomeConstant' does not point to a valid class name" do
-    ['not.aclass', 'self', 'AnotherClass.new'].each do |klass|
-      Registry.clear
-      undoc_error <<-eof
-        CONST = #{klass}
-        class << CONST; end
-      eof
-      Registry.at(klass).should be_nil
-    end
-  end
-  
   it "should document 'class Exception' without running into superclass issues" do
     Parser::SourceParser.parse_string <<-eof
       class Exception

data/spec/handlers/class_variable_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassVariableHandler" do
-  before { parse_file :class_variable_handler_001, __FILE__ }
+  before(:all) { parse_file :class_variable_handler_001, __FILE__ }
   
   it "should not parse class variables inside methods" do
     Registry.at("A::B::@@somevar").source.should == "@@somevar = \"hello\""

data/spec/handlers/constant_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ConstantHandler" do
-  before { parse_file :constant_handler_001, __FILE__ }
+  before(:all) { parse_file :constant_handler_001, __FILE__ }
   
   it "should not parse constants inside methods" do
     Registry.at("A::B::SOMECONSTANT").source.should == "SOMECONSTANT= \"hello\""

data/spec/handlers/exception_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ExceptionHandler" do
-  before { parse_file :exception_handler_001, __FILE__ }
+  before(:all) { parse_file :exception_handler_001, __FILE__ }
   
   it "should not document an exception outside of a method" do
     P('Testing').has_tag?(:raise).should == false

data/spec/handlers/extend_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ExtendHandler" do
-  before { parse_file :extend_handler_001, __FILE__ }
+  before(:all) { parse_file :extend_handler_001, __FILE__ }
 
   it "should include modules at class scope" do
     Registry.at(:B).class_mixins.should == [P(:A)]

data/spec/handlers/method_condition_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}MethodConditionHandler" do
-  before { parse_file :method_condition_handler_001, __FILE__ }
+  before(:all) { parse_file :method_condition_handler_001, __FILE__ }
   
   it "should not parse regular if blocks in methods" do
     Registry.at('#b').should be_nil

data/spec/handlers/method_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}MethodHandler" do
-  before do
+  before(:all) do
     log.enter_level(Logger::ERROR) do
       parse_file :method_handler_001, __FILE__ 
     end
@@ -19,8 +19,8 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}MethodHandler" do
     P("String.hello").should be_instance_of(CodeObjects::MethodObject)
   end
   
-  it "should allow punctuation in method names ([], ?, =~, <<, etc.)" do
-    [:[], :[]=, :allowed?, :/, :=~, :==, :`, :|, :*, :&, :%, :'^', :-@, :+@, :'~@'].each do |name|
+  [:[], :[]=, :allowed?, :/, :=~, :==, :`, :|, :*, :&, :%, :'^', :-@, :+@, :'~@'].each do |name|
+    it "should allow valid method #{name}" do
       Registry.at("Foo##{name}").should_not be_nil
     end
   end

data/spec/handlers/mixin_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}MixinHandler" do
-  before { parse_file :mixin_handler_001, __FILE__ }
+  before(:all) { parse_file :mixin_handler_001, __FILE__ }
   
   it "should handle includes from classes or modules" do
     Registry.at(:X).instance_mixins.should include(P(:A))
@@ -24,7 +24,7 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}MixinHandler" do
   end
   
   it "should handle includes with multiple parameters" do
-    Registry.at(:X)
+    Registry.at(:X).should_not be_nil
   end
   
   it "should handle complex include statements" do

data/spec/handlers/module_handler_spec.rb

@@ -1,10 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ModuleHandler" do
-  before do
-    Registry.clear 
-    parse_file :module_handler_001, __FILE__
-  end
+  before(:all) { parse_file :module_handler_001, __FILE__ }
 
   it "should parse a module block" do
     Registry.at(:ModName).should_not == nil

data/spec/handlers/spec_helper.rb

@@ -7,6 +7,13 @@ def undoc_error(code)
   lambda { StubbedSourceParser.parse_string(code) }.should raise_error(Parser::UndocumentableError)
 end
 
+def with_parser(parser_type, &block)
+  tmp = StubbedSourceParser.parser_type
+  StubbedSourceParser.parser_type = parser_type
+  yield
+  StubbedSourceParser.parser_type = tmp
+end
+
 class StubbedProcessor < Processor
   def process(statements)
     statements.each_with_index do |stmt, index|
@@ -18,7 +25,7 @@ class StubbedProcessor < Processor
 end
 
 class StubbedSourceParser < Parser::SourceParser
-  self.parser_type = :ruby
+  StubbedSourceParser.parser_type = :ruby
   def post_process
     post = StubbedProcessor.new(@file, @load_order_errors, @parser_type)
     post.process(@parser.enumerator)

data/spec/handlers/visibility_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}VisibilityHandler" do
-  before { parse_file :visibility_handler_001, __FILE__ }
+  before(:all) { parse_file :visibility_handler_001, __FILE__ }
   
   it "should be able to set visibility to public" do
     Registry.at("Testing#pub").visibility.should == :public

data/spec/handlers/yield_handler_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
 describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}YieldHandler" do
-  before { parse_file :yield_handler_001, __FILE__ }
+  before(:all) { parse_file :yield_handler_001, __FILE__ }
   
   it "should only parse yield blocks in methods" do
     P(:Testing).tag(:yield).should be_nil

data/spec/parser/ruby/ruby_parser_spec.rb

@@ -48,6 +48,25 @@ if RUBY19
         s.comments.should == "comment"
         s.comments_range.should == (1..1)
       end
+      
+      it "should handle 1.9 lambda syntax with args" do
+        src = "->(a,b,c=1,*args,&block) { hello_world }"
+        stmt(src).source.should == src
+      end
+      
+      it "should handle 1.9 lambda syntax" do
+        src = "-> { hello_world }"
+        stmt(src).source.should == src
+      end
+          
+      it "should handle standard lambda syntax" do
+        src = "lambda { hello_world }"
+        stmt(src).source.should == src
+      end
+      
+      it "should throw a ParserSyntaxError on invalid code" do
+        lambda { stmt("Foo, bar.") }.should raise_error(YARD::Parser::ParserSyntaxError)
+      end
     end
   end
 end

data/spec/parser/source_parser_spec.rb

@@ -68,4 +68,24 @@ describe YARD::Parser::SourceParser do
       msgs[5].should =~ /Object MyModule successfully resolved/
     end
   end
+  
+  describe '#parse_statements' do
+    it "should display a warning for C/C++ files" do
+      log.should_receive(:warn).with(/no support/)
+      YARD::Parser::SourceParser.parse_string("int main() { }", :c)
+    end
+    
+    it "should display a warning for invalid parser type" do
+      log.should_receive(:warn).with(/unrecognized file/)
+      YARD::Parser::SourceParser.parse_string("int main() { }", :d)
+    end
+    
+    if RUBY19
+      it "should display a warning for a syntax error (with new parser)" do
+        err_msg = "Syntax error in `(stdin)`:(1,3): syntax error, unexpected $undefined, expecting $end"
+        log.should_receive(:warn).with(err_msg)
+        YARD::Parser::SourceParser.parse_string("$$$", :ruby)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yard
 version: !ruby/object:Gem::Version 
-  version: 0.2.3.3
+  version: 0.2.3.4
 platform: ruby
 authors: 
 - Loren Segal
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-26 00:00:00 -04:00
+date: 2009-08-07 00:00:00 -04:00
 default_executable: 
 dependencies: []