templates/default/html/module.erb @@ -18,20 +18,41 @@ ac.puts <<-eof <body> <h3>All Classes</h3> eof +am = File.open("doc/all-modules.html", "w") +am.puts <<-eof +<html> + <head> + <base target="main" /> + </head> + <body> + <h3>All Modules</h3> +eof meths = [] Namespace.all.sort.each do |path| object = Namespace.at(path) - if object.is_a?(MethodObject) && object.visibility == :public + if object.is_a?(MethodObject) && (object.visibility == :protected || object.visibility == :public) meths << [object.name, object] end - next unless object.is_a? ClassObject - ac.puts "<a href='" + path.gsub("::","_") + ".html'>" + path + "</a><br />" + indexfile = nil + + case object + when ClassObject + indexfile = ac + when ModuleObject + indexfile = am + else + next + end + + indexfile.puts "<a href='" + path.gsub("::","_") + ".html'>" + path + "</a><br />" puts "Generating " + (docfile = "doc/#{path.gsub('::','_')}.html") + "..." File.open(docfile, "w") {|f| f.write(object.to_s) } end ac.puts "</body></html>" ac.close +am.puts "</body></html>" +am.close File.open("doc/all-methods.html", "w") do |f| f.puts <<-eof @@ -41,7 +62,7 @@ File.open("doc/all-methods.html", "w") do |f| </head> <body> <h3>All Methods</h3> -eof + eof meths.sort {|a,b| a.first <=> b.first }.each do |name, object| f.puts "<a href='" + object.parent.path.gsub("::", "_") + ".html##{object.scope}_method-#{name}'>#{name}</a><br />" end @@ -63,8 +84,9 @@ File.open("doc/index.html", "w") do |f| <title>Ruby Classes</title> </head> <frameset cols="250,*"> - <frameset rows="*,40%"> + <frameset rows="40%,40%,20%"> <frame src="all-classes.html"> + <frame src="all-modules.html"> <frame src="all-methods.html"> </frameset> <frame name="main" src="#{main_page}"> bin/yardoc @@ -131,7 +131,7 @@ module YARD #:nodoc: # # def path - [(parent.path if parent && parent.type != :root), name].join(scope == :instance ? "#" : "::").gsub(/^::/, '') + [(parent.path if parent && parent.type != :root), name].join(scope == :instance ? "#" : "::").gsub(/^::/, '').strip end ## @@ -221,6 +221,7 @@ module YARD #:nodoc: class CodeObjectWithMethods < CodeObject def initialize(name, type, parent = nil, comments = nil) super(name, type, :public, :class, parent, comments) do |obj| + obj[:attributes] = {} obj[:instance_methods] = {} obj[:class_methods] = {} obj[:constants] = {} @@ -255,6 +256,11 @@ module YARD #:nodoc: yield(obj) if block_given? end end + + def superclasses + #STDERR.puts "Warning: someone expected module #{path} to respond to #superclasses" + [] + end end class ClassObject < CodeObjectWithMethods @@ -262,7 +268,6 @@ module YARD #:nodoc: def initialize(name, superclass = BASE_OBJECT, *args) super(name, :class, *args) do |obj| - obj[:attributes] = {} obj[:superclass] = superclass yield(obj) if block_given? end @@ -282,8 +287,9 @@ module YARD #:nodoc: def superclasses superobject = Namespace.find_from_path(path, superclass) - return [superclass] unless superobject.respond_to? :superclasses - [superobject.path] + (superobject.path == 'Object' ? [] : superobject.superclasses) + return ["Object"] unless superobject + return [] if path == superobject.path + [superobject.path, *superobject.superclasses] end def inheritance_tree @@ -298,7 +304,8 @@ module YARD #:nodoc: # @param [CodeObjectWithMethods] parent the object that holds this method def initialize(name, visibility, scope, parent, comments = nil) super(name, :method, visibility, scope, parent, comments) do |obj| - parent["#{scope}_methods".to_sym].update(name.to_s => obj) + pmethods = parent["#{scope}_methods".to_sym] + pmethods.update(name.to_s => obj) if pmethods yield(obj) if block_given? end end lib/code_object.rb @@ -38,6 +38,10 @@ module YARD filename = File.join(template_directory, template.to_s, format.to_s, "#{type}.erb") Erubis::Eruby.new("<% extend #{format.to_s.capitalize}Formatter %>\n" + IO.read(filename), :trim => true).result(_binding) + rescue => e + STDERR.puts "Could not render template #{filename}: #{e.message}" + STDERR.puts e.backtrace[0, 5].map {|x| "\t#{x}" } + STDERR.puts end end lib/formatter.rb @@ -1,5 +1,5 @@ class YARD::ConstantHandler < YARD::CodeObjectHandler - HANDLER_MATCH = /\A[^@\$]\S*\s*=\s*/m + HANDLER_MATCH = /\A[^@\$]\S*\s*=[^=]\s*/m handles HANDLER_MATCH def process lib/handlers/constant_handler.rb @@ -8,6 +8,7 @@ class YARD::MixinHandler < YARD::CodeObjectHandler rescue NameError object.mixins.push statement.tokens[1..-1].to_s end + object.mixins.map! {|mixin| mixin.strip } object.mixins.flatten! object.mixins.uniq! end lib/handlers/mixin_handler.rb @@ -1,6 +1,3 @@ -require "e2mmap" -require "irb/slex" - module YARD module RubyToken EXPR_BEG = :EXPR_BEG @@ -90,9 +87,6 @@ module YARD case token when String, Symbol source = token.kind_of?(String) ? TkReading2Token : TkSymbol2Token - if (tk = source[token]).nil? - IRB.fail TkReading2TokenNoKey, token - end tk = Token(tk[0], value) else tk = if (token.ancestors & [TkId, TkVal, TkOPASGN, TkUnknownChar]).empty? @@ -245,18 +239,12 @@ module YARD def RubyToken.def_token(token_n, super_token = Token, reading = nil, *opts) token_n = token_n.id2name unless token_n.kind_of?(String) - if RubyToken.const_defined?(token_n) - #IRB.fail AlreadyDefinedToken, token_n - end token_c = Class.new super_token RubyToken.const_set token_n, token_c # token_c.inspect if reading - if TkReading2Token[reading] - IRB.fail TkReading2TokenDuplicateError, token_n, reading - end if opts.empty? TkReading2Token[reading] = [token_c] else @@ -411,7 +399,6 @@ module YARD def_exception(:SyntaxError, "%s") include RubyToken - include IRB attr_reader :continue attr_reader :lex_state lib/ruby_lex.rb @@ -56,7 +56,10 @@ module YARD begin handler.new(self, stmt).process rescue => e - raise "Handler error: #{e} in #{file}:#{stmt.tokens.first.line_no}" + STDERR.puts "#{handler.to_s} error in `#{file}`:#{stmt.tokens.first.line_no}: #{stmt.tokens.to_s}" + STDERR.puts "Exception message: #{e.message}" + STDERR.puts e.backtrace[0, 5] + STDERR.puts end end end lib/source_parser.rb @@ -1,5 +1,5 @@ module YARD - VERSION = "0.2.0" + VERSION = "0.2.1" end require File.dirname(__FILE__) + '/logger' lib/yard.rb @@ -21,13 +21,17 @@ td { padding: 3px; } </style> <base target="_self" /> - </head> + </head <body> <h1>Class <%= path %></h1> +<% unless superclasses.empty? %> <pre> <% spaces = 0 -%> -<% superclasses.reverse.each do |superclass| -%><%= (" " * spaces) + (spaces > 0 ? "+--" : "") + link_to_path(superclass) + "\n" %><% spaces += (spaces == 0 ? 2 : 4) -%><%= (" " * spaces) + "|\n" %><% end -%><%= (" " * spaces ) + "+--" + path %> +<% superclasses.reverse.each do |superclass| -%><%= (" " * spaces) + (spaces > 0 ? "+--" : "") + link_to_path(superclass) %> +<% spaces += (spaces == 0 ? 2 : 4) -%><%= (" " * spaces) + "|" %> +<% end -%><%= (" " * spaces ) + "+--" + path %> </pre> +<% end %> <% unless mixins.empty? %> <p> @@ -200,7 +204,7 @@ </th> </tr> <tr> - <td><%= meths.reject {|name, m| superclass.send("#{scope}_methods").has_key? name }. + <td><%= superclass.send("#{scope}_methods").reject {|name, m| meths.include? name }. collect {|name, m| "<tt>" + link_to_path(superclass.path + (scope == :instance ? "#" : "::") + name, nil, name) + "</tt>" }.join(", ") %></td> </tr> templates/default/html/class.erb doc/Logger.html doc/RubyLex.html doc/RubyLex_BufferedReader.html doc/RubyToken_TkError.html doc/RubyToken_TkId.html doc/RubyToken_TkKW.html doc/RubyToken_TkNode.html doc/RubyToken_TkOPASGN.html doc/RubyToken_TkOp.html doc/RubyToken_TkUnknownChar.html doc/RubyToken_TkVal.html doc/RubyToken_Token.html doc/TestCodeObject.html doc/TestNamespace.html doc/YARD_AttributeHandler.html doc/YARD_AuthorTag.html doc/YARD_BaseTag.html doc/YARD_BaseTypeTag.html doc/YARD_ClassHandler.html doc/YARD_ClassObject.html doc/YARD_ClassVariableHandler.html doc/YARD_ClassVariableObject.html doc/YARD_CodeObject.html doc/YARD_CodeObjectHandler.html doc/YARD_CodeObjectWithMethods.html doc/YARD_ConstantHandler.html doc/YARD_ConstantObject.html doc/YARD_DeprecatedTag.html doc/YARD_ExceptionHandler.html doc/YARD_Formatter.html doc/YARD_MethodHandler.html doc/YARD_MethodObject.html doc/YARD_MixinHandler.html doc/YARD_ModuleHandler.html doc/YARD_ModuleObject.html doc/YARD_NameStruct.html doc/YARD_Namespace.html doc/YARD_ParamTag.html doc/YARD_QuickDoc.html doc/YARD_ReturnTag.html doc/YARD_RubyLex.html doc/YARD_RubyLex_BufferedReader.html doc/YARD_RubyToken_TkError.html doc/YARD_RubyToken_TkId.html doc/YARD_RubyToken_TkKW.html doc/YARD_RubyToken_TkNode.html doc/YARD_RubyToken_TkOPASGN.html doc/YARD_RubyToken_TkOp.html doc/YARD_RubyToken_TkUnknownChar.html doc/YARD_RubyToken_TkVal.html doc/YARD_RubyToken_Token.html doc/YARD_SourceParser.html doc/YARD_Statement.html doc/YARD_StatementList.html doc/YARD_Tag.html doc/YARD_TokenList.html doc/YARD_VisibilityHandler.html doc/YARD_YieldHandler.html doc/all-classes.html doc/all-methods.html doc/index.html aac637c8e89535800e27760d334e7cc7c2869843 loren loren@a99b2113-df67-db11-8bcc-000c76553aea http://github.com/lsegal/yard/commit/2b8a715f61201f6bf2a6033a26137d41bc677409 2b8a715f61201f6bf2a6033a26137d41bc677409

2008-02-24T11:13:00-08:00

Tag 0.2.1 git-svn-id: http://soen.ca/svn/projects/ruby/yard/tags/0.2.1@801 a99b2113-df67-db11-8bcc-000c76553aea 746424c20ae14582f7810e7f03c8335b4adc516f loren loren@a99b2113-df67-db11-8bcc-000c76553aea