yard 0.5.4 → 0.5.5

data/.yardopts

@@ -12,3 +12,4 @@ docs/Templates.md
 docs/Glossary.md
 ChangeLog
 LICENSE
+LEGAL

data/ChangeLog

@@ -1,3 +1,158 @@
+2010-05-22  Loren Segal <lsegal@soen.ca>
+
+  * ChangeLog, README.md, lib/yard.rb, yard.gemspec: Bump version to 0.5.5
+
+2010-05-21  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb: Clean
+  path names when parsing source files  Closes gh-129
+
+2010-05-10  Michael Edgar <michael.j.edgar@dartmouth.edu>
+
+  * lib/yard/handlers/ruby/legacy/method_handler.rb,
+  lib/yard/handlers/ruby/method_handler.rb,
+  spec/handlers/examples/method_handler_001.rb.txt,
+  spec/handlers/method_handler_spec.rb: Auto-generate parameters referred to by
+  @option tags.  Closes gh-16
+
+  * lib/yard/docstring.rb, spec/docstring_spec.rb: Resolve reftags the same way
+  as normal references  Closes gh-14
+
+2010-05-21  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/code_objects/base.rb, lib/yard/code_objects/proxy.rb: Remove #hash
+  implementation due to weird Registry reloading side effects
+
+  * lib/yard/tags/default_factory.rb, spec/tags/default_factory_spec.rb: Type
+  list in tag text should only be listed at the beginning or after first token.
+   Closes gh-120
+
+  * templates/default/module/html/box_info.erb,
+  templates/default/module/text/extends.erb: Rename "Extends" to "Extended by"
+  for class mixins in templates.  Closes gh-110
+
+  * lib/yard/templates/helpers/html_helper.rb: Revert automatic typewriter
+  textifying of links
+
+  * lib/yard/templates/helpers/base_helper.rb,
+  lib/yard/templates/helpers/html_helper.rb,
+  spec/templates/examples/class001.html,
+  spec/templates/helpers/base_helper_spec.rb,
+  spec/templates/helpers/html_helper_spec.rb,
+  templates/default/tags/html/see.erb: Refactor #resolve_links into #linkify to
+  handle 'file:' and URL links more consistently across templates.  Closes
+  gh-121
+
+  * lib/yard/code_objects/module_object.rb,
+  spec/code_objects/module_object_spec.rb: Fix mixins listing twice for
+  #inheritance_tree on module objects
+
+2010-05-21  wycats <wycats@gmail.com>
+
+  * lib/yard/code_objects/base.rb, lib/yard/code_objects/class_object.rb,
+  lib/yard/code_objects/proxy.rb, spec/code_objects/class_object_spec.rb: Fixes
+  an issue where mixins could appear twice in the class hierarchy
+
+2010-05-15  postmodern <postmodern.mod3@gmail.com>
+
+  * lib/yard.rb: Only glob .rb files from yard/core_ext and do not strip the
+  .rb file extension.  * By globbing all files within yard/core_ext, this was
+  triggering a bug on Rubinius 1.0. Rubinius likes to store compiled Ruby files
+  (.rbc) along with the Ruby source files (.rb).
+  http://github.com/evanphx/rubinius/issues/#issue/305
+
+2010-05-15  Loren Segal <lsegal@soen.ca>
+
+  * .../ruby/legacy/class_condition_handler.rb,
+  spec/handlers/class_condition_handler_spec.rb: Implement
+  ClassConditionHandler for legacy parser.  Closes gh-114
+
+  * lib/yard/parser/ruby/legacy/statement_list.rb,
+  spec/parser/ruby/legacy/statement_list_spec.rb: Fill .block for 'else' and
+  'elsif' statements in legacy parser.
+
+2010-05-04  Denis Defreyne <denis.defreyne@stoneship.org>
+
+  * templates/default/docstring/html/private.erb,
+  templates/default/docstring/setup.rb,
+  templates/default/docstring/text/private.erb,
+  templates/default/fulldoc/html/css/style.css,
+  templates/default/module/html/header.erb,
+  templates/default/module/html/item_summary.erb: Show notification for "@api
+  private" usage in HTML/text templates.  Closes gh-123
+
+2010-04-21  Loren Segal <lsegal@soen.ca>
+
+  * LEGAL: Update LEGAL
+
+  * .yardopts, LEGAL, LICENSE, README.md, yard.gemspec: Add Ruby/RDoc license
+  information to YARD and update copyright years.  Closes gh-122
+
+2010-04-20  Nathan Weizenbaum <nex342@gmail.com>
+
+  * lib/yard/cli/yard_graph.rb, lib/yard/cli/yardoc.rb,
+  lib/yard/templates/helpers/module_helper.rb, spec/templates/module_spec.rb:
+  Replace the :visibilities option with compilation to a query.  This allows
+  the visibility flags to be used with --list.
+
+  * lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Parse yardopts and manual
+  args at the same time.  This means that e.g. --query arguments are merged,
+  rather than clobbered.
+
+2010-04-19  Nathan Weizenbaum <nex342@gmail.com>
+
+  * lib/yard/cli/yardoc.rb: Add a --list option for listing all objects
+  matching the query.
+
+2010-04-20  Nathan Weizenbaum <nex342@gmail.com>
+
+  * lib/yard/templates/helpers/method_helper.rb: Don't assume that method
+  parameter names will be strings.  In the case of some overloads with default
+  values, at least, they'll be symbols.
+
+2010-04-19  Nathan Weizenbaum <nex342@gmail.com>
+
+  * lib/yard/handlers/ruby/constant_handler.rb,
+  lib/yard/handlers/ruby/legacy/constant_handler.rb: Register MethodObjects
+  defined for structs.  Otherwise, they don't get their file/line number set.
+
+2010-04-01  Loren Segal <lsegal@soen.ca>
+
+  * spec/templates/examples/class001.html,
+  spec/templates/examples/method001.html,
+  spec/templates/examples/module001.html,
+  templates/default/docstring/html/abstract.erb,
+  templates/default/docstring/html/deprecated.erb,
+  templates/default/docstring/html/note.erb,
+  templates/default/docstring/html/todo.erb,
+  templates/default/fulldoc/html/css/style.css: Fix templates to not wrap
+  htmlify_line inside a <p> tag, since it itself is a <div>
+
+2010-03-27  Loren Segal <lsegal@soen.ca>
+
+  * spec/templates/examples/class001.html,
+  spec/templates/examples/module001.html: Fix specs for summary toggle button
+
+  * templates/default/fulldoc/html/css/style.css,
+  templates/default/fulldoc/html/js/app.js,
+  .../default/module/html/attribute_summary.erb,
+  templates/default/module/html/method_summary.erb: Add method/attribute
+  summary collapse/expand
+
+2010-03-24  Loren Segal <lsegal@soen.ca>
+
+  * templates/default/fulldoc/html/js/app.js: Don't enable keyboard shortcuts
+  in frames mode.
+
+  * templates/default/fulldoc/html/css/style.css: Move shadow over so it does
+  not force horizontal scrollbars to appear.
+
+  * templates/default/fulldoc/html/js/app.js: Ignore shortcut keypresses inside
+  form input fields
+
+  * templates/default/fulldoc/html/setup.rb: Make sure there are no nil
+  children
+
 2010-03-22  Loren Segal <lsegal@soen.ca>
 
   * ChangeLog, README.md, docs/WhatsNew.md, lib/yard.rb, yard.gemspec: Bump
@@ -224,6 +379,32 @@
   * lib/yard/templates/helpers/html_helper.rb: HTML-escape text that isn't
   syntax highlighted due to --no-highlight.
 
+2010-01-24  Nathan Weizenbaum <nex342@gmail.com>
+
+  * lib/yard/templates/template.rb: When dealing with many overloaded
+  templates, include them in reverse order.  This is necessary due to the way
+  Ruby's module inclusion works with inheritance.  Including a module puts it
+  at the base of the inheritance chain.  For example, if a class hierarchy
+  looks like A->B->C, and C includes D, then it looks like A->B->D->C. This
+  means that the base template, which is last in the full_paths list, should
+  actually be included first, so that it ends up farthest back in the
+  inheritance chain.
+
+2010-01-21  Nathan Weizenbaum <nex342@gmail.com>
+
+  * lib/yard/templates/helpers/html_helper.rb: Allow a broader variety of names
+  for syntax highlighting.  This is necessary to support some names for
+  Pygments.
+
+2010-01-17  Nathan Weizenbaum <nex342@gmail.com>
+
+  * lib/yard/templates/helpers/html_helper.rb: HTML-escape text that isn't
+  syntax highlighted due to --no-highlight.
+
+  * lib/yard/autoload.rb, lib/yard/templates/erb_cache.rb,
+  lib/yard/templates/template.rb, spec/templates/template_spec.rb: Cache the
+  compiled ERB methods to speed up rendering time.
+
 2010-01-11  Loren Segal <lsegal@soen.ca>
 
   * README.md: Fix links in README

data/LEGAL

@@ -0,0 +1,74 @@
+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.
+
+    Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+    You can redistribute it and/or modify it under either the terms of the GPL
+    version 2 (see the file GPL), or the conditions below:
+
+      1. You may make and give away verbatim copies of the source form of the
+         software without restriction, provided that you duplicate all of the
+         original copyright notices and associated disclaimers.
+
+      2. You may modify your copy of the software in any way, provided that
+         you do at least ONE of the following:
+
+           a) place your modifications in the Public Domain or otherwise
+              make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+           b) use the modified software only within your corporation or
+              organization.
+
+           c) give non-standard binaries non-standard names, with
+              instructions on where to get the original software distribution.
+
+           d) make other distribution arrangements with the author.
+
+      3. You may distribute the software in object code or binary form,
+         provided that you do at least ONE of the following:
+
+           a) distribute the binaries and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+           b) accompany the distribution with the machine-readable source of
+          the software.
+
+           c) give non-standard binaries non-standard names, with
+              instructions on where to get the original software distribution.
+
+           d) make other distribution arrangements with the author.
+
+      4. You may modify and include the part of the software into any other
+         software (possibly commercial).  But some files in the distribution
+         are not written by the author, so that they are not under these terms.
+
+         For the list of those files and their copying conditions, see the
+         file LEGAL.
+
+      5. The scripts and library files supplied as input to or produced as 
+         output from the software do not automatically fall under the
+         copyright of the software, but belong to whomever generated them, 
+         and may be sold commercially, and may be aggregated with this
+         software.
+
+      6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+         IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+         WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+         PURPOSE.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2009 Loren Segal
+Copyright (c) 2007-2010 Loren Segal
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,12 +1,14 @@
 YARD Release 0.5.4 "The Longest" (Mar 22nd 2010)
 ================================================
 
-**Homepage**:  [http://yardoc.org](http://yardoc.org)   
-**IRC**:       **Join us on IRC in #yard on irc.freenode.net!**   
-**Git**:       [http://github.com/lsegal/yard](http://github.com/lsegal/yard)   
-**Author**:    Loren Segal   
-**Copyright**: 2007-2010
-**License**:   MIT License
+**Homepage**:     [http://yardoc.org](http://yardoc.org)   
+**IRC**:          **Join us on IRC in #yard on irc.freenode.net!**   
+**Git**:          [http://github.com/lsegal/yard](http://github.com/lsegal/yard)   
+**Author**:       Loren Segal  
+**Contributors**: Nathan Weizenbaum, Yehuda Katz, Denis Defreyne, Postmodern, 
+                  Michael Edgar    
+**Copyright**:    2007-2010    
+**License**:      MIT License    
 
 
 SYNOPSIS
@@ -222,6 +224,9 @@ More options can be seen by typing `yard-graph --help`, but here is an example:
 CHANGELOG
 ---------
 
+- **May.22.10**: 0.5.5 release
+    - Various bug fixes
+
 - **March.22.10**: 0.5.4 release
     - See {file:docs/WhatsNew.md what's new document} for changes
 
@@ -291,5 +296,7 @@ CHANGELOG
 COPYRIGHT
 ---------
 
-YARD © 2007-2009 by [Loren Segal](mailto:lsegal@soen.ca). Licensed under the MIT 
-license. Please see the {file:LICENSE} for more information.
+YARD © 2007-2010 by [Loren Segal](mailto:lsegal@soen.ca). YARD is 
+licensed under the MIT license except for some files which come from the
+RDoc/Ruby distributions. Please see the {file:LICENSE} and {file:LEGAL} 
+documents for more information.

data/lib/yard.rb

@@ -1,5 +1,5 @@
 module YARD
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
   ROOT = File.expand_path(File.dirname(__FILE__))
   TEMPLATE_ROOT = File.join(ROOT, '..', 'templates')
   CONFIG_DIR = File.expand_path('~/.yard')
@@ -52,8 +52,8 @@ $LOAD_PATH.push('.') if RUBY_VERSION >= '1.9.2'
 RUBY19, RUBY18 = *(RUBY_VERSION >= "1.9.1" ? [true, false] : [false, true])
 
 # Load Ruby core extension classes
-Dir.glob(File.join(YARD::ROOT, 'yard', 'core_ext', '*')).each do |file|
-  require file.gsub(/\.rb$/, '')
+Dir.glob(File.join(YARD::ROOT, 'yard', 'core_ext', '*.rb')).each do |file|
+  require file
 end
 
 ['autoload', 'globals'].each do |file| 

data/lib/yard/cli/yard_graph.rb

@@ -22,10 +22,7 @@ module YARD
       def initialize
         super
         @serializer = YARD::Serializers::StdoutSerializer.new
-        @options = SymbolHash[
-          :format => :dot,
-          :visibilities => [:public]
-        ]
+        @options = SymbolHash[:format => :dot]
       end
       
       # Runs the command-line utility.
@@ -39,8 +36,9 @@ module YARD
         optparse(*args)
         
         contents = objects.map {|o| o.format(options) }.join("\n")
-        Templates::Engine.render(:format => :dot, :type => :layout, 
-          :serializer => @serializer, :contents => contents) 
+        Templates::Engine.render(:format => :dot, :type => :layout,
+          :verifier => @verifier, :serializer => @serializer,
+          :contents => contents)
       end
       
       private
@@ -48,6 +46,7 @@ module YARD
       # Parses commandline options.
       # @param [Array<String>] args each tokenized argument
       def optparse(*args)
+        visibilities = []
         opts = OptionParser.new
 
         opts.separator ""
@@ -66,15 +65,15 @@ module YARD
         end
         
         opts.on('--no-public', "Don't show public methods. (default shows public)") do 
-          options[:visibilities].delete(:public)
+          visibilities.delete(:public)
         end
 
         opts.on('--protected', "Show or don't show protected methods. (default hides protected)") do
-          options[:visibilities].push(:protected)
+          visibilities.push(:protected)
         end
 
         opts.on('--private', "Show or don't show private methods. (default hides private)") do 
-          options[:visibilities].push(:private) 
+          visibilities.push(:private)
         end
 
         opts.separator ""
@@ -92,6 +91,7 @@ module YARD
         common_options(opts)
         parse_options(opts, args)
 
+        @verifier = Verfier.new("object.type != :method || #{visibilities.uniq.inspect}.include?(object.visibility)")
         if args.first
           @objects = args.map {|o| Registry.at(o) }.compact
         else
@@ -100,4 +100,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/cli/yardoc.rb

@@ -28,7 +28,10 @@ module YARD
       
       # @return [Boolean] whether to generate output
       attr_accessor :generate
-      
+
+      # @return [Boolean] whether to print a list of objects
+      attr_accessor :list
+
       # The options file name (defaults to {DEFAULT_YARDOPTS_FILE})
       # @return [String] the filename to load extra options from
       attr_accessor :options_file
@@ -50,7 +53,6 @@ module YARD
           :hide_void_return => false,
           :no_highlight => false, 
           :files => [],
-          :visibilities => [:public],
           :verifier => nil
         )
         @excluded = []
@@ -68,8 +70,7 @@ module YARD
       # @return [void] 
       def run(*args)
         args += support_rdoc_document_file!
-        optparse(*yardopts)
-        optparse(*args)
+        optparse(*(yardopts + args))
         
         if use_cache
           Registry.load
@@ -85,6 +86,8 @@ module YARD
             Registry.load_all if use_cache
             Templates::Engine.generate(all_objects, options)
           end
+        elsif list
+          print_list
         end
         
         true
@@ -125,6 +128,17 @@ module YARD
         end
       end
 
+      # Prints a list of all objects
+      # @return [void]
+      def print_list
+        Registry.load_all
+        Registry.all.
+          reject {|item| options[:verifier].call(item).is_a?(FalseClass) }.
+          sort_by {|item| [item.file, item.line]}.each do |item|
+          puts "#{item.file}:#{item.line}: #{item}"
+        end
+      end
+
       # Reads a .document file in the directory to get source file globs
       # @return [void] 
       def support_rdoc_document_file!
@@ -197,6 +211,7 @@ module YARD
       def optparse(*args)
         excluded = []
         query_expressions = []
+        visibilities = [:public]
         do_build_gems, do_rebuild_gems = false, false
         serialopts = SymbolHash.new
         
@@ -264,15 +279,15 @@ module YARD
         opts.separator "Output options:"
   
         opts.on('--no-public', "Don't show public methods. (default shows public)") do 
-          options[:visibilities].delete(:public)
+          visibilities.delete(:public)
         end
 
         opts.on('--protected', "Show or don't show protected methods. (default hides protected)") do
-          options[:visibilities].push(:protected)
+          visibilities.push(:protected)
         end
 
         opts.on('--private', "Show or don't show private methods. (default hides private)") do 
-          options[:visibilities].push(:private) 
+          visibilities.push(:private)
         end
         
         opts.on('--no-private', "Hide objects with @private tag") do
@@ -294,7 +309,12 @@ module YARD
         opts.on('--query QUERY', "Only show objects that match a specific query") do |query|
           query_expressions << query.taint
         end
-        
+
+        opts.on('--list', 'List objects to standard out (implies -n)') do |format|
+          self.generate = false
+          self.list = true
+        end
+
         opts.on('--title TITLE', 'Add a specific title to HTML documents') do |title|
           options[:title] = title
         end
@@ -354,8 +374,8 @@ module YARD
         build_gems(do_rebuild_gems) if do_build_gems
         parse_files(*args) unless args.empty?
         self.files = ['lib/**/*.rb', 'ext/**/*.c'] if self.files.empty?
+        query_expressions << "object.type != :method || #{visibilities.uniq.inspect}.include?(object.visibility)"
         options[:verifier] = Verifier.new(*query_expressions) unless query_expressions.empty?
-        options[:visibilities].uniq!
         options[:serializer] ||= Serializers::FileSystemSerializer.new(serialopts)
         options[:readme] ||= Dir.glob('README*').first
       end