yard 0.7.5 → 0.8.0

data/LEGAL

@@ -1,15 +1,15 @@
 LEGAL NOTICE INFORMATION
 ------------------------
 
-All the files in this distribution are covered under either the MIT 
+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.  
+
+    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:
@@ -62,9 +62,9 @@ lib/parser/ruby/legacy/ruby_lex.rb:
          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 
+      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, 
+         copyright of the software, but belong to whomever generated them,
          and may be sold commercially, and may be aggregated with this
          software.
 

data/LICENSE

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

data/README.md

@@ -8,8 +8,8 @@ YARD: Yay! A Ruby Documentation Tool
 **Contributors**: See Contributors section below    
 **Copyright**:    2007-2012    
 **License**:      MIT License    
-**Latest Version**: 0.7.5 (codename "Jackson")    
-**Release Date**: January 31st 2012    
+**Latest Version**: 0.8.0 (codename "Shave It")    
+**Release Date**: April 30th 2012    
 
 Synopsis
 --------
@@ -23,7 +23,7 @@ summary of some of YARD's notable features.
 
 Feature List
 ------------
-                                                                              
+
 **1. RDoc/SimpleMarkup Formatting Compatibility**: YARD is made to be compatible
 with RDoc formatting. In fact, YARD does no processing on RDoc documentation
 strings, and leaves this up to the output generation tool to decide how to
@@ -34,8 +34,8 @@ YARD uses a '@tag' style definition syntax for meta tags alongside  regular code
 documentation. These tags should be able to happily sit side by side RDoc formatted
 documentation, but provide a much more consistent and usable way to describe
 important information about objects, such as what parameters they take and what types
-they are expected to be, what type a method should return, what exceptions it can 
-raise, if it is deprecated, etc.. It also allows information to be better (and more 
+they are expected to be, what type a method should return, what exceptions it can
+raise, if it is deprecated, etc.. It also allows information to be better (and more
 consistently) organized during the output generation phase. You can find a list
 of tags in the {file:docs/Tags.md#taglist Tags.md} file.
 
@@ -46,15 +46,15 @@ describing this data in the body of the description, a developer may formally
 declare the parameter or return type(s) in a single line. Consider the
 following method documented with YARD formatting:
 
-     # Reverses the contents of a String or IO object. 
-     # 
-     # @param [String, #read] contents the contents to reverse 
-     # @return [String] the contents reversed lexically 
-     def reverse(contents) 
-       contents = contents.read if respond_to? :read 
-       contents.reverse 
+     # Reverses the contents of a String or IO object.
+     #
+     # @param [String, #read] contents the contents to reverse
+     # @return [String] the contents reversed lexically
+     def reverse(contents)
+       contents = contents.read if respond_to? :read
+       contents.reverse
      end
-                                                                     
+
 With the above @param tag, we learn that the contents parameter can either be
 a String or any object that responds to the 'read' method, which is more
 powerful than the textual description, which says it should be an IO object.
@@ -62,16 +62,16 @@ This also informs the developer that they should expect to receive a String
 object returned by the method, and although this may be obvious for a
 'reverse' method, it becomes very useful when the method name may not be as
 descriptive.
-                                                                              
-**3. Custom Constructs and Extensibility of YARD**: YARD is designed to be 
-extended and customized by plugins. Take for instance the scenario where you 
+
+**3. Custom Constructs and Extensibility of YARD**: YARD is designed to be
+extended and customized by plugins. Take for instance the scenario where you
 need to document the following code:
-   
+
     class List
       # Sets the publisher name for the list.
       cattr_accessor :publisher
     end
-                                                                        
+
 This custom declaration provides dynamically generated code that is hard for a
 documentation tool to properly document without help from the developer. To
 ease the pains of manually documenting the procedure, YARD can be extended by
@@ -83,7 +83,7 @@ consumption by the users.
 YARD is also designed for extensibility everywhere else, allowing you to add
 support for new programming languages, new data structures and even where/how
 data is stored.
-                                                                              
+
 **4. Raw Data Output**: YARD also outputs documented objects as raw data (the
 dumped Namespace) which can be reloaded to do generation at a later date, or
 even auditing on code. This means that any developer can use the raw data to
@@ -98,35 +98,33 @@ test cases, for example, or show possible unhandled exceptions in code.
 **5. Local Documentation Server**: YARD can serve documentation for projects
 or installed gems (similar to `gem server`) with the added benefit of dynamic
 searching, as well as live reloading. Using the live reload feature, you can
-document your code and immediately preview the results by refreshing the page; 
-YARD will do all the work in re-generating the HTML. This makes writing 
+document your code and immediately preview the results by refreshing the page;
+YARD will do all the work in re-generating the HTML. This makes writing
 documentation a much faster process.
 
 
-Installing
-----------
+## Installing
 
 To install YARD, use the following command:
 
     $ gem install yard
-    
+
 (Add `sudo` if you're installing under a POSIX system as root)
-    
-Alternatively, if you've checked the source out directly, you can call 
+
+Alternatively, if you've checked the source out directly, you can call
 `rake install` from the root project directory.
 
 **Important Note for Debian/Ubuntu users:** there's a possible chance your Ruby
-install lacks RDoc, which is occasionally used by YARD to convert markup to HTML. 
+install lacks RDoc, which is occasionally used by YARD to convert markup to HTML.
 If running `which rdoc` turns up empty, install RDoc by issuing:
 
     $ sudo apt-get install rdoc
-                                                                              
 
-Usage
------
+
+## Usage
 
 There are a couple of ways to use YARD. The first is via command-line, and the
-second is the Rake task. 
+second is the Rake task.
 
 **1. yard Command-line Tool**
 
@@ -135,7 +133,7 @@ functions of YARD, including generating documentation, graphs running the
 YARD server, and so on. To view a list of available YARD commands, type:
 
     $ yard --help
-    
+
 Plugins can also add commands to the `yard` executable to provide extra
 functionality.
 
@@ -143,18 +141,18 @@ functionality.
 
 <span class="note">The `yardoc` executable is a shortcut for `yard doc`.</span>
 
-The most common command you will probably use is `yard doc`, or `yardoc`. You 
-can type `yardoc --help` to see the options that YARD provides, but the 
-easiest way to generate docs for your code is to simply type `yardoc` in your 
+The most common command you will probably use is `yard doc`, or `yardoc`. You
+can type `yardoc --help` to see the options that YARD provides, but the
+easiest way to generate docs for your code is to simply type `yardoc` in your
 project root. This will assume your files are
 located in the `lib/` directory. If they are located elsewhere, you can specify
 paths and globs from the commandline via:
 
     $ yardoc 'lib/**/*.rb' 'app/**/*.rb' ...etc...
-    
+
 The tool will generate a `.yardoc` file which will store the cached database
 of your source code and documentation. If you want to re-generate your docs
-with another template you can simply use the `--use-cache` (or -c) 
+with another template you can simply use the `--use-cache` (or -c)
 option to speed up the generation process by skipping source parsing.
 
 YARD will by default only document code in your public visibility. You can
@@ -170,7 +168,7 @@ You can also add extra informative files (README, LICENSE) by separating
 the globs and the filenames with '-'.
 
     $ yardoc 'app/**/*.rb' - README LICENSE FAQ
-    
+
 If no globs precede the '-' argument, the default glob (`lib/**/*.rb`) is
 used:
 
@@ -179,7 +177,7 @@ used:
 Note that the README file can be specified with its own `--readme` switch.
 
 You can also add a `.yardopts` file to your project directory which lists
-the switches separated by whitespace (newlines or space) to pass to yardoc 
+the switches separated by whitespace (newlines or space) to pass to yardoc
 whenever it is run. A full overview of the `.yardopts` file can be found in
 {YARD::CLI::Yardoc}.
 
@@ -195,20 +193,20 @@ the same result:
     --query 'object.has_tag?(:api) && object.tag(:api).text == "public"'
     --query 'has_tag?(:api) && tag(:api).text == "public"'
 
-Note that the "@tag" syntax returns the first tag named "tag" on the object. 
+Note that the "@tag" syntax returns the first tag named "tag" on the object.
 To return the array of all tags named "tag", use "@@tag".
-    
+
 Multiple `--query` arguments are allowed in the command line parameters. The
 following two lines both check for the existence of a return and param tag:
 
     --query '@return' --query '@param'
     --query '@return && @param'
-    
+
 For more information about the query syntax, see the {YARD::Verifier} class.
 
 **2. Rake Task**
 
-The second most obvious is to generate docs via a Rake task. You can do this by 
+The second most obvious is to generate docs via a Rake task. You can do this by
 adding the following to your `Rakefile`:
 
     YARD::Rake::YardocTask.new do |t|
@@ -223,7 +221,7 @@ in a shell. You can also override the options at the Rake command-line with the
 OPTS environment variable:
 
     $ rake yard OPTS='--any --extra --opts'
-                                                                              
+
 **3. `yri` RI Implementation**
 
 The yri binary will use the cached .yardoc database to give you quick ri-style
@@ -232,15 +230,15 @@ work with the stdlib or core Ruby libraries, only the active project. Example:
 
     $ yri YARD::Handlers::Base#register
     $ yri File.relative_path
-    
-Note that class methods must not be referred to with the "::" namespace 
+
+Note that class methods must not be referred to with the "::" namespace
 separator. Only modules, classes and constants should use "::".
 
 You can also do lookups on any installed gems. Just make sure to build the
 .yardoc databases for installed gems with:
 
     $ sudo yard gems
-    
+
 If you don't have sudo access, it will write these files to your `~/.yard`
 directory. `yri` will also cache lookups there.
 
@@ -250,7 +248,7 @@ The `yard server` command serves documentation for a local project or all instal
 RubyGems. To serve documentation for a project you are working on, simply run:
 
     $ yard server
-    
+
 And the project inside the current directory will be parsed (if the source has
 not yet been scanned by YARD) and served at [http://localhost:8808](http://localhost:8808).
 
@@ -266,7 +264,7 @@ change any documentation in the source and refresh to see the new contents.
 To serve documentation for all installed gems, call:
 
     $ yard server --gems
-    
+
 This will also automatically build documentation for any gems that have not
 been previously scanned. Note that in this case there will be a slight delay
 between the first request of a newly parsed gem.
@@ -274,37 +272,50 @@ between the first request of a newly parsed gem.
 
 **5. `yard graph` Graphviz Generator**
 
-You can use `yard-graph` to generate dot graphs of your code. This, of course,
+You can use `yard graph` to generate dot graphs of your code. This, of course,
 requires [Graphviz](http://www.graphviz.org) and the `dot` binary. By default
 this will generate a graph of the classes and modules in the best UML2 notation
 that Graphviz can support, but without any methods listed. With the `--full`
 option, methods and attributes will be listed. There is also a `--dependencies`
 option to show mixin inclusions. You can output to stdout or a file, or pipe directly
-to `dot`. The same public, protected and private visibility rules apply to yard-graph.
-More options can be seen by typing `yard-graph --help`, but here is an example:
+to `dot`. The same public, protected and private visibility rules apply to `yard graph`.
+More options can be seen by typing `yard graph --help`, but here is an example:
 
     $ yard graph --protected --full --dependencies
 
 
-Changelog
----------
+## Changelog
+
+- **April.30.12**: 0.8.0 release
+    - See {file:docs/WhatsNew.md} for a list of added features
+    - Over 20 bug fixes:
+      - Properly filter hidden setter/getter attributes (#394)
+      - Fix test failures in Linux environments (#397, #472, #473, #512, #513)
+      - Fix attribute inheritance and @private (#432)
+      - Fix attribute parsing (#435)
+      - Allow aliases for attributes (#436)
+      - Fix namespace fetching in `handle_alias()` (#437)
+      - Fix overwritten attributes marked as inherited (#442)
+      - Fix documenting constants defined from C code with `rb_define_const()` (#443)
+      - Do not escape snippets twice (#445)
+      - Ajax method/class search should not fire when a non-printable character is pressed (#446)
+      - Fix yard server crashing when RDoc is not installed (#456)
+      - Fix tags ignored when `(see #foo)` is used (#457)
+      - Fix three "Returns" for two `@overload` tags (#458)
+      - Do not auto-detect DSL methods as method objects if parameter name is not a valid method name (#464)
+      - Fix attaching of macros to Object (#465)
+      - Fix handling of `%w()` source in `[]/[]=` parsed context. (#461, pull in #468)
+      - Don't add default `@return` if `@overload` has `@return`. (#458, pull in #469)
+      - Don't discard tags by (see ...). (#457, pull in #470)
+      - Fix constants listed as inherited when overwritten (#474)
+      - Fix `yardoc --asset` behaving differently on first and subsequent calls. (#477)
+      - `!!!lang` code blocks should set the lang in `<pre>`'s class. (#478, #479)
+      - Fix "File List" search tab error. (#502)
+      - Fix search bar not redirecting to method page. (#509)
+      - Fix server returning exception message bodies as String (#518)
 
 - **January.31.12**: 0.7.5 release
-    - Mostly bugfix release (backports from 0.8.0 branch, full list in #467)
-    - Don't show inherited attributes if overridden (#432)
-    - Capture definitions in `/* definition: docstring */` format in C Ruby (#443)
-    - Do not escape highlighted code blocks twice (#445)
-    - Ignore non-printable characters in search autocomplete (#446)
-    - Verify markup options when loading .yardopts file in server mode (#456)
-    - Don't discard tags in (see ...) references (#457)
-    - Don't add @return to methods ending in '?' if has @overload (#458)
-    - Fix listing of source for %w() blocks with arrays (#461)
-    - Do not detect invalid method names as DSL methods (#464)
-    - Allow processing of macros attached to Object class (#465)
-    - Multi-object db is only enabled via switch (#466)
-    - Ignore inherited constants if overridden (#474)
-    - Do not copy asset inside dest directory if source is directory (#477)
-    - Set pre className when !!!lang is used to denote highlight language (#478, #479)
+    - Various minor bug fixes
 
 - **December.2.11**: 0.7.4 release
     - Redcarpet is now the default Markdown formatting library. GFM now works out-of-box (#404)
@@ -499,33 +510,31 @@ Changelog
       RDoc. To take advantage of this plugin, set `has_rdoc = 'yard'` in your
       .gemspec file.
 
-- **Jun.07.09**: 0.2.3 release. See the {file:docs/WhatsNew.md} file for a 
+- **Jun.07.09**: 0.2.3 release. See the {file:docs/WhatsNew.md} file for a
   list of important new features.
 
-- **Jun.16.08**: 0.2.2 release. This is the largest changset since yard's 
+- **Jun.16.08**: 0.2.2 release. This is the largest changset since yard's
   conception and involves a complete overhaul of the parser and API to make it
   more robust and far easier to extend and use for the developer.
 
-- **Feb.20.08**: 0.2.1 release. 
+- **Feb.20.08**: 0.2.1 release.
 
 - **Feb.24.07**: Released 0.1a experimental version for testing. The goal here is
-  to get people testing YARD on their code because there are too many possible  
-  code styles to fit into a sane amount of test cases. It also demonstrates the 
-  power of YARD and what to expect from the syntax (Yardoc style meta tags).    
+  to get people testing YARD on their code because there are too many possible
+  code styles to fit into a sane amount of test cases. It also demonstrates the
+  power of YARD and what to expect from the syntax (Yardoc style meta tags).
 
 
-Contributors
-------------
+## Contributors
 
 Special thanks to all contributors for submitting patches. A full list of
-contributors including their patches can be found at: 
+contributors including their patches can be found at:
 
 http://github.com/lsegal/yard/contributors
 
-Copyright
----------
+## Copyright
 
-YARD &copy; 2007-2011 by [Loren Segal](mailto:lsegal@soen.ca). YARD is 
+YARD &copy; 2007-2012 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} 
+RDoc/Ruby distributions. Please see the {file:LICENSE} and {file:LEGAL}
 documents for more information.

data/Rakefile

@@ -14,7 +14,7 @@ task :gem do
 end
 
 desc "Installs the gem"
-task :install => :gem do 
+task :install => :gem do
   sh "#{SUDO} gem install yard-#{YARD::VERSION}.gem --no-rdoc --no-ri"
 end
 
@@ -60,14 +60,14 @@ begin
   desc "Run all specs"
   RSpec::Core::RakeTask.new("specs") do |t|
     $DEBUG = true if ENV['DEBUG']
-    t.rspec_opts = ENV['SUITE'] ? ['--format', 'progress'] : ["--colour", "--format", "documentation"]
+    t.rspec_opts = ENV['SUITE'] ? [] : ['-c']
     t.rspec_opts += ["--require", File.join(File.dirname(__FILE__), 'spec', 'spec_helper')]
     t.rspec_opts += ['-I', YARD::ROOT]
     t.pattern = "spec/**/*_spec.rb"
     t.verbose = $DEBUG ? true : false
-  
+
     if ENV['RCOV']
-      t.rcov = true 
+      t.rcov = true
       t.rcov_opts = ['-x', hide]
     end
   end
@@ -76,7 +76,7 @@ rescue LoadError
   begin # Try for rspec 1.x
     require 'spec'
     require 'spec/rake/spectask'
-    
+
     Spec::Rake::SpecTask.new("specs") do |t|
       $DEBUG = true if ENV['DEBUG']
       t.spec_opts = ["--format", "specdoc", "--colour"]
@@ -84,7 +84,7 @@ rescue LoadError
       t.pattern = "spec/**/*_spec.rb"
 
       if ENV['RCOV']
-        t.rcov = true 
+        t.rcov = true
         t.rcov_opts = ['-x', hide]
       end
     end

data/benchmarks/builtins_vs_eval.rb

@@ -9,7 +9,7 @@ end
 
 def bench_eval(name)
   eval(name).is_a?(Class)
-rescue 
+rescue
   false
 end