yard 0.7.3 → 0.7.4

data/ChangeLog

@@ -1,3 +1,143 @@
+2011-12-03  Loren Segal <lsegal@soen.ca>
+
+  * ChangeLog, README.md, docs/WhatsNew.md, lib/yard.rb: Bump to version 0.7.4
+  and update README/ChangeLog/WhatsNew
+
+  * lib/yard/templates/helpers/markup_helper.rb: Revert loading of RDoc inside
+  of markup helper, load it in RDocMarkup instead (since JRuby does not like
+  this all the time)
+
+  * lib/yard/templates/helpers/markup/rdoc_markup.rb: JRuby doesn't like doing
+  a require 'rdoc' without the gem.
+
+  * lib/yard/templates/helpers/markup/rdoc_markup.rb,
+  spec/templates/helpers/html_helper_spec.rb: Add support for RDoc 3.10 which
+  no longer requires 'rdoc' inside markup sources
+
+  * lib/yard/server/commands/search_command.rb: Prune search results according
+  to verifiers (no-private, etc.)  This should ensure that the server side
+  search results are in sync with the statically generated class/method lists. 
+  Closes #420
+
+  * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Add support for
+  rb_define_alias  Closes #413
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  lib/yard/templates/helpers/markup_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb: Re-organize markup types text,
+  none, and add type 'pre'.  The new behaviour for the types are as follows: 
+  pre: Pre-formatted text, wrapping input inside <pre> tags. text: No
+  formatting except for replacing newlines with <br> tags. none: No formatting
+  at all.  In all cases, HTML is escaped. Note that syntax highlighting does
+  not work in these markup types.  Closes #416
+
+2011-12-02  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  lib/yard/templates/helpers/markup_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb: Add 'textile_strict' markup type
+  that uses strict hard breaks on newlines
+
+  * lib/yard/templates/helpers/markup/rdoc_markup.rb,
+  spec/templates/helpers/markup/rdoc_markup_spec.rb: Ignore +typewritertext+
+  inside code blocks  Closes #403
+
+  * lib/yard/templates/helpers/markup_helper.rb,
+  spec/templates/helpers/markup_helper_spec.rb: Redcarpet is now the default
+  markdown provider for YARD
+
+  * lib/yard/templates/helpers/html_helper.rb: Autolink when using red carpet
+
+  * .../helpers/html_syntax_highlight_helper_spec.rb: Fix specs to use new css
+  rules when generating HTML syntax highlighted Ruby
+
+  * .../helpers/html_syntax_highlight_helper.rb,
+  templates/default/fulldoc/html/css/style.css,
+  templates/guide/fulldoc/html/css/style.css: Change generated HTML when
+  performing syntax highlighting of Ruby code to generate ids with CSS prefix
+  "rubyid_" to avoid collisions with other CSS class names.
+
+2011-12-01  Mark Morga <markmorga@gmail.com>
+
+  * lib/yard/rake/yardoc_task.rb: Documentation improvements in YardocTask. 
+  Fixed attr :options to indicate that it should be an Array<String> rather
+  than Hash. Added an example for attr :files to show correct use of "-" for
+  extra files.
+
+2011-11-28  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/server/commands/library_command.rb,
+  .../doc_server/processing/html/processing.erb: Server "processing" response
+  should return HTTP code 202 Accepted instead of 302.  This change makes
+  IE8/IE9 happier about redirects, and is the proper response code for this
+  situation.  Closes #418
+
+2011-11-26  Kouhei Sutou <kou@clear-code.com>
+
+  * lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb:
+  support encoding detection in C source file.
+
+  * spec/parser/source_parser_spec.rb: accept 'coding: ENCODING; OTHER
+  PARAMTERS' style encoding line.
+
+  * lib/yard/parser/source_parser.rb, spec/parser/source_parser_spec.rb:
+  support UTF-8 as encoding name.
+
+2011-11-25  Kouhei Sutou <kou@clear-code.com>
+
+  * spec/registry_store_spec.rb: ensure test directory nonexistent.
+
+2011-11-09  yuta yamada <yamada@clear-code.com>
+
+  * README.md: fix a typo.
+
+2011-11-06  Loren Segal <lsegal@soen.ca>
+
+  * templates/default/fulldoc/html/css/style.css,
+  templates/guide/fulldoc/html/css/style.css: Better CSS targeting to handle
+  example identifiers inside code blocks  Closes #410
+
+2011-11-04  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/templates/helpers/markup_helper.rb: Require 'rdoc' when loading
+  RDoc markup. Fixes issues with new RDoc 3.x markup loading.  Closes #406,
+  #407
+
+2011-10-21  Loren Segal <lsegal@soen.ca>
+
+  * templates/default/fulldoc/html/js/app.js: Actually want nextAll(), not
+  next() when filtering next elements in collapse/view source links
+
+  * templates/default/fulldoc/html/js/app.js: Be more specific about which
+  next() element to toggle (collapse and view source JS event handlers)
+
+  * docs/GettingStarted.md: Fix link to types.html
+
+2011-10-20  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/rubygems/specification.rb: Also ensure that has_rdoc is always
+  boolean inside of has_rdoc? (in case accessor was not called by newer
+  RubyGems)  References #401
+
+  * lib/yard/rubygems/specification.rb: Ensure that has_rdoc is true by default
+  (always boolean)  Closes #401
+
+2011-10-16  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Error early if files have
+  markup formats that are not available on the system
+
+  * lib/yard/code_objects/base.rb: Remove unused self.line setting method. 
+  This method was initiating a dispatch to method_missing, since the method did
+  not exist, and was silently setting an attribute on the object that is never
+  used.
+
+  * lib/yard/code_objects/base.rb: Implement to_ary on CodeObjects::Base  Ruby
+  1.9.2+ likes to ask the base object if it responds to to_ary when
+  Array#flatten is called on a list. This causes method_missing to be
+  dispatched to and incurs significant overhead. A 6% performance improvement
+  was noted for implementing this method alone.
+
 2011-10-15  Loren Segal <lsegal@soen.ca>
 
   * ChangeLog, README.md, lib/yard.rb: Update README, ChangeLog and bump to

data/README.md

@@ -8,8 +8,8 @@ YARD: Yay! A Ruby Documentation Tool
 **Contributors**: See Contributors section below    
 **Copyright**:    2007-2011    
 **License**:      MIT License    
-**Latest Version**: 0.7.3 (codename "Rhombus")    
-**Release Date**: October 15th 2011    
+**Latest Version**: 0.7.4 (codename "Kennedy")    
+**Release Date**: December 2nd 2011    
 
 Synopsis
 --------
@@ -171,7 +171,7 @@ the globs and the filenames with '-'.
 
     $ yardoc 'app/**/*.rb' - README LICENSE FAQ
     
-If no globs preceed the '-' argument, the default glob (`lib/**/*.rb`) is
+If no globs precede the '-' argument, the default glob (`lib/**/*.rb`) is
 used:
 
     $ yardoc - README LICENSE FAQ
@@ -289,6 +289,18 @@ More options can be seen by typing `yard-graph --help`, but here is an example:
 Changelog
 ---------
 
+- **December.2.11**: 0.7.4 release
+    - Redcarpet is now the default Markdown formatting library. GFM now works out-of-box (#404)
+    - Fix server side searching for elements that are marked private (#420)
+    - Add 'textile_strict' and 'pre' markup types, reorganize text and none (#416)
+    - Improve encoding line detection (#415)
+    - Add support for `rb_define_alias` in CRuby code (#413)
+    - Fix rendering of some keywords in source view (#410)
+    - Add support for RDoc 3.10+ (#406, #407)
+    - Fix typewriter text being processed in code blocks (#403)
+    - Improve support for has_rdoc in RubyGems 1.8.x (#401)
+    - See the {file:docs/WhatsNew.md} document for details on added features
+
 - **October.15.11**: 0.7.3 release
     - Improve support for parsing under Ruby 1.9.2p290 and 1.9.3 (#365, #370)
     - Add support for SWIG generated CRuby code (#369)
@@ -308,7 +320,7 @@ Changelog
     - Fixes a bug in `yard server` not displaying class list properly.
 
 - **May.17.11**: 0.7.0 release
-    - See the {docs/WhatsNew.md} document for details on added features
+    - See the {file:docs/WhatsNew.md} document for details on added features
     - Make sure that Docstring#line_range is filled when possible (#243)
     - Set #verifier in YardocTask (#282)
     - Parse BOM in UTF-8 files (#288)

data/docs/GettingStarted.md

@@ -181,8 +181,9 @@ Symbols:
 We mentioned that these type fields are "mostly" free-form. In truth, they
 are defined "by convention". To view samples of common type specifications
 and recommended conventions for writing type specifications, see 
-http://yardoc.org/types.html. Note that these conventions may change every now 
-and then, although we are working on a more "formal" type specification proposal.
+[http://yardoc.org/types.html](http://yardoc.org/types.html). Note that these 
+conventions may change every now and then, although we are working on a more 
+"formal" type specification proposal.
 
 ## Documenting DSL Methods
 

data/docs/WhatsNew.md

@@ -16,6 +16,10 @@
 12. **Added before/after callbacks to SourceParser** (0.7.0)
 13. **Can now use `--yardopts FILE` to specify a custom yardopts file** (0.7.0)
 14. **Added new `-t guide` template for guide based docs** (0.7.0)
+15. **Github Flavoured Markdown now works out-of-box** (0.7.4)
+16. **Added `-m textile_strict` and `-m pre` markup types** (0.7.4)
+17. **Reorganized markup types 'text' and 'none'** (0.7.4)
+18. **Add support for `rb_define_alias`** (0.7.4)
 
 ## Macro support and detection of DSL methods (0.7.0)
 
@@ -175,6 +179,56 @@ questions, trouble shooting and license page.
 If you need to refer to class / method documentation, you can embed API documentation
 using the `{render:Object}` tag discussed above.
 
+## Github Flavoured Markdown now works out-of-box (0.7.4)
+
+Due to the growing popularity of Github-Flavoured-Markdown (GFM), YARD now uses
+the Redcarpet library as the default Markdown formatting library with GFM fenced
+code blocks enabled. This means that you can use fenced code blocks inside of
+Markdown files with redcarpet installed without any extra code. Previously, users
+who wanted GFM in their Markdown would have to specify `-m markdown -M redcarpet`,
+but this is now the default behaviour for YARD.
+
+Note that you can still specify language types in code blocks without GFM in YARD
+by using the "!!!lang" prefix syntax. For example (plain means no markup):
+
+    !!!plain
+    !!!plain
+    Some code
+    block here.
+
+The GFM version would be:
+
+    !!!plain
+    ```plain
+    Some code
+    block here.
+    ```
+
+## Added `-m textile_strict` and `-m pre` markup types (0.7.4)
+
+A new "textile_strict" markup type was added which behaves exactly like "textile"
+except it enables hard breaks, so newlines behave as line breaks in the HTML
+(using `<br>` tags). This option is added for users who want the classic textile
+behaviour.
+
+## Reorganized markup types 'text' and 'none' (0.7.4)
+
+Due to the new pre markup type, the behaviour for text and none were slightly
+reorganized to be more intuitive. The following behaviours now represent these
+markup types:
+
+ * pre: Used to wrap text inside `<pre>` tags
+ * text: No formatting except for hard breaks (`<br>`) on newlines
+ * none: No formatting at all.
+ 
+In all cases, HTML is escaped from input. If you want no HTML escaping, use the
+html markup type.
+
+## Add support for `rb_define_alias` (0.7.4)
+
+CRuby code can now make use of the `rb_define_alias` function. Documentation
+for aliases is not supported, however.
+
 # What's New in 0.6.x?
 
 1. **Local documentation server for RubyGems or projects (`yard server`)** (0.6.0)

data/lib/yard.rb

@@ -1,5 +1,5 @@
 module YARD
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 
   # The root path for YARD source libraries
   ROOT = File.expand_path(File.dirname(__FILE__))

data/lib/yard/cli/yardoc.rb

@@ -311,10 +311,15 @@ module YARD
       #
       # @return (see YARD::Templates::Helpers::MarkupHelper#load_markup_provider)
       def verify_markup_options
-        options[:markup] = :rdoc unless has_markup
         result, lvl = false, has_markup ? log.level : Logger::FATAL
         obj = Struct.new(:options).new(options)
         obj.extend(Templates::Helpers::MarkupHelper)
+        options[:files].each do |file|
+          markup = file.attributes[:markup] || obj.markup_for_file('', file.filename)
+          result = obj.load_markup_provider(markup)
+          return false if !result && markup != :rdoc
+        end
+        options[:markup] = :rdoc unless has_markup
         log.enter_level(lvl) { result = obj.load_markup_provider }
         if !result && !has_markup
           log.warn "Could not load default RDoc formatter, " +

data/lib/yard/code_objects/base.rb

@@ -284,6 +284,9 @@ module YARD
 
       # @return [Integer] the object's hash value (for equality checking)
       def hash; path.hash end
+      
+      # @return [nil] this object does not turn into an array
+      def to_ary; nil end
 
       # Accesses a custom attribute on the object
       # @param [#to_s] key the name of the custom attribute
@@ -336,7 +339,6 @@ module YARD
       #   as a +String+ for the definition of the code object only (not the block)
       def source=(statement)
         if statement.respond_to?(:source)
-          self.line = statement.line
           self.signature = statement.first_line
           @source = format_source(statement.source.strip)
         else

data/lib/yard/parser/c_parser.rb

@@ -15,6 +15,7 @@ module YARD
         parse_modules
         parse_classes
         parse_methods
+        parse_aliases
         parse_attributes
         parse_constants
         parse_includes
@@ -100,6 +101,30 @@ module YARD
         obj
       end
       
+      def handle_alias(var_name, new_name, old_name)
+        namespace = P(remove_var_prefix(var_name))
+        ensure_loaded!(namespace)
+        new_meth, old_meth = new_name.to_sym, old_name.to_sym
+        old_obj = namespace.child(:name => old_meth, :scope => :instance)
+        new_obj = YARD::CodeObjects::MethodObject.new(namespace, new_meth, :instance) do |o|
+          o.visibility = :public
+          o.scope = :instance
+          o.add_file(@file)
+          o.source_type = :c
+        end
+
+        if old_obj
+          new_obj.signature = old_obj.signature
+          new_obj.source = old_obj.source
+          new_obj.docstring = old_obj.docstring
+          new_obj.docstring.object = new_obj
+        else
+          new_obj.signature = "def #{new_meth}" # this is all we know.
+        end
+
+        namespace.aliases[new_obj] = old_meth
+      end
+      
       def handle_attribute(var_name, name, func_name, read, write, source_file = nil)
         values = {:read => read.to_i, :write => write.to_i}
         {:read => name, :write => "#{name}="}.each do |type, meth_name|
@@ -379,6 +404,18 @@ module YARD
         end
       end
       
+      def parse_aliases
+        @content.scan(%r{rb_define_alias
+                       \s*\(\s*([\w\.]+),
+                         \s*"([^"]+)",
+                         \s*"([^"]+)"\s*\)
+                     }xm) do |var_name, new_name, old_name|
+
+          var_name = "rb_cObject" if var_name == "rb_mKernel"
+          handle_alias(var_name, new_name, old_name)
+        end
+      end
+      
       def parse_attributes
         @content.scan(%r{rb_define_attr
                        \s*\(\s*([\w\.]+),

data/lib/yard/parser/source_parser.rb

@@ -43,7 +43,7 @@ module YARD
     # @see CodeObjects::Base
     class SourceParser
       SHEBANG_LINE  = /\A\s*#!\S+/
-      ENCODING_LINE = /\A(?:\s*#*!.*\r?\n)?\s*#+.*coding\s*[:=]{1,2}\s*(\S+)/i
+      ENCODING_LINE = /\A(?:\s*#*!.*\r?\n)?\s*(?:#+|\/\*+|\/\/+).*coding\s*[:=]{1,2}\s*([a-z\d_\-]+)/i
       
       # Byte order marks for various encodings
       # @since 0.7.0

data/lib/yard/rake/yardoc_task.rb

@@ -11,11 +11,15 @@ module YARD
       attr_accessor :name
 
       # Options to pass to {CLI::Yardoc}
-      # @return [Hash] the options passed to the commandline utility
+      # @return [Array<String>] the options passed to the commandline utility
       attr_accessor :options
 
       # The Ruby source files (and any extra documentation files separated by '-')
-      # to process
+      # to process.
+      # @example Task files assignment
+      #   YARD::Rake::YardocTask.new do |t|
+      #     t.files   = ['app/**/*.rb', 'lib/**/*.rb', '-', 'doc/FAQ.md', 'doc/Changes.md']
+      #   end
       # @return [Array<String>] a list of files
       attr_accessor :files
 

data/lib/yard/rubygems/specification.rb

@@ -12,14 +12,14 @@ class Gem::Specification
 
   undef has_rdoc?
   def has_rdoc?
-    @has_rdoc && @has_rdoc != 'yard'
+    (@has_rdoc ||= true) && @has_rdoc != 'yard'
   end
 
   alias has_yardoc? has_yardoc
 
   # has_rdoc should not be ignored!
   if respond_to?(:overwrite_accessor)
-    overwrite_accessor(:has_rdoc) { @has_rdoc }
+    overwrite_accessor(:has_rdoc) { @has_rdoc ||= true }
     overwrite_accessor(:has_rdoc=) {|v| @has_rdoc = v }
   else
     attr_accessor :has_rdoc

data/lib/yard/server/commands/library_command.rb

@@ -89,7 +89,7 @@ module YARD
         def not_prepared
           self.caching = false
           options.update(:path => request.path, :template => :doc_server, :type => :processing)
-          [302, {'Content-Type' => 'text/html'}, [render]]
+          [202, {'Content-Type' => 'text/html'}, [render]]
         end
 
         # @private

data/lib/yard/server/commands/search_command.rb

@@ -4,6 +4,9 @@ module YARD
       # Performs a search over the objects inside of a library and returns
       # the results as HTML or plaintext
       class SearchCommand < LibraryCommand
+        include Templates::Helpers::BaseHelper
+        include Templates::Helpers::ModuleHelper
+
         attr_accessor :results, :query
 
         def run
@@ -47,7 +50,7 @@ module YARD
 
         def search_for_object
           splitquery = query.split(/\s+/).map {|c| c.downcase }.reject {|m| m.empty? }
-          self.results = Registry.all.select {|o|
+          self.results = run_verifier(Registry.all).select {|o|
               o.path.downcase.include?(query.downcase)
             }.reject {|o|
               name = (o.type == :method ? o.name(true) : o.name).to_s.downcase

data/lib/yard/server/templates/doc_server/processing/html/processing.erb

@@ -8,7 +8,7 @@
     <script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
     <script type="text/javascript" charset="utf-8">
       function checkPage(process) {
-        $.ajax({cache: false, url: "<%= @path %>" + (process ? "?process=true" : ""), success: function() { window.location = "<%= @path %>"; } });
+        $.ajax({cache: false, url: "<%= @path %>" + (process ? "?process=true" : ""), statusCode: { 200: function() { window.location = "<%= @path %>"; } } });
         setTimeout('checkPage()', 2000);
       }
       function setFade() {

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

@@ -51,7 +51,7 @@ module YARD
           string = html_syntax_highlight(CGI.unescapeHTML(string), language) unless options[:no_highlight]
           classes = ['code', language].compact.join(' ')
           %Q{<pre class="#{classes}">#{string}</pre>}
-        end unless markup == :text
+        end unless [:text, :none, :pre].include?(markup)
         html
       end
 
@@ -63,11 +63,11 @@ module YARD
         # TODO: other libraries might be more complex
         provider = markup_class(:markdown)
         if provider.to_s == 'RDiscount'
-          markup_class(:markdown).new(text, :autolink).to_html
+          provider.new(text, :autolink).to_html
         elsif provider.to_s == 'RedcarpetCompat'
-          provider.new(text, :gh_blockcode, :fenced_code).to_html
+          provider.new(text, :gh_blockcode, :fenced_code, :autolink).to_html
         else
-          markup_class(:markdown).new(text).to_html
+          provider.new(text).to_html
         end
       end
 
@@ -81,6 +81,14 @@ module YARD
         doc.to_html
       end
 
+      # Converts plaintext to strict Textile (hard breaks)
+      # @param [String] text the input textile data
+      # @return [String] the output HTML
+      # @since 0.6.0
+      def html_markup_textile_strict(text)
+        markup_class(:textile).new(text).to_html
+      end
+
       # Converts RDoc formatting (SimpleMarkup) to HTML
       # @param [String] text the input RDoc formatted text
       # @return [String] output HTML
@@ -91,18 +99,26 @@ module YARD
         doc.to_html
       end
 
-      # Converts plaintext to HTML
+      # Converts plaintext to pre-formatted HTML
       # @param [String] text the input text
       # @return [String] the output HTML
       # @since 0.6.0
-      def html_markup_text(text)
+      def html_markup_pre(text)
         "<pre>" + h(text) + "</pre>"
       end
 
+      # Converts plaintext to regular HTML
+      # @param [String] text the input text
+      # @return [String] the output HTML
+      # @since 0.6.0
+      def html_markup_text(text)
+        h(text).gsub(/\r?\n/, '<br/>')
+      end
+
       # @return [String] the same text with no markup
       # @since 0.6.6
       def html_markup_none(text)
-        h(text).gsub(/(?:\r?\n){2}/, '<br/>')
+        h(text)
       end
 
       # Converts HTML to HTML

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

@@ -25,7 +25,7 @@ module YARD
             when :nl, :ignored_nl, :sp
               output << h(s.last)
             when :ident
-              output << "<span class='id #{h(s.last)}'>#{h(s.last)}</span>"
+              output << "<span class='id identifier rubyid_#{h(s.last)}'>#{h(s.last)}</span>"
             else
               output << "<span class='#{s.first}'>#{h(s.last)}</span>"
             end
@@ -47,7 +47,7 @@ module YARD
               h s.text
             when Parser::Ruby::Legacy::RubyToken::TkId
               prettyval = h(s.text)
-              "<span class='#{prettyval} #{prettyclass} #{prettysuper}'>#{prettyval}</span>"
+              "<span class='rubyid_#{prettyval} #{prettyclass} #{prettysuper}'>#{prettyval}</span>"
             else
               "<span class='#{prettyclass} #{prettysuper}'>#{h s.text}</span>"
             end

data/lib/yard/templates/helpers/markup/rdoc_markup.rb

@@ -2,6 +2,7 @@ module YARD
   module Templates
     module Helpers
       module Markup
+        begin require 'rdoc'; rescue LoadError; end
         begin
           require 'rdoc/markup'
           require 'rdoc/markup/to_html'
@@ -41,14 +42,16 @@ module YARD
           #
           # @todo Refactor into own SimpleMarkup subclass
           def fix_typewriter(text)
-            text.gsub(/(\s|^|>)\+(?! )([^\n\+]{1,900})(?! )\+/) do
-              first_text, type_text, pre_text, no_match = $1, $2, $`, $&
-              pre_match = (pre_text+first_text).scan(%r(</?(?:(?:pre|tt|code).*?>|[^>]+)\Z))
-              if pre_match.last.nil? || pre_match.last[1,1] == '/'
-                first_text + '<tt>' + CGI.escapeHTML(type_text) + '</tt>'
-              else
-                no_match
+            code_tags = 0
+            text.gsub(/<(\/)?(pre|code|tt)|(\s|^|>)\+(?! )([^\n\+]{1,900})(?! )\+/) do |str|
+              closed, tag, first_text, type_text, pre_text, no_match = $1, $2, $3, $4, $`, $&
+              
+              if tag
+                code_tags += (closed ? -1 : 1)
+                next str
               end
+              next str unless code_tags == 0
+              first_text + '<tt>' + CGI.escapeHTML(type_text) + '</tt>'
             end
           end
 

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

@@ -22,21 +22,25 @@ module YARD
       # The default list of markup providers for each markup type
       MARKUP_PROVIDERS = {
         :markdown => [
+          {:lib => :redcarpet, :const => 'RedcarpetCompat'},
           {:lib => :rdiscount, :const => 'RDiscount'},
           {:lib => :kramdown, :const => 'Kramdown::Document'},
           {:lib => :bluecloth, :const => 'BlueCloth'},
           {:lib => :maruku, :const => 'Maruku'},
-          {:lib => :redcarpet, :const => 'RedcarpetCompat'},
           {:lib => :'rpeg-markdown', :const => 'PEGMarkdown'},
         ],
         :textile => [
           {:lib => :redcloth, :const => 'RedCloth'},
         ],
+        :textile_strict => [
+          {:lib => :redcloth, :const => 'RedCloth'},
+        ],
         :rdoc => [
           {:lib => nil, :const => 'YARD::Templates::Helpers::Markup::RDocMarkup'},
         ],
         :ruby => [],
         :text => [],
+        :pre  => [],
         :html => [],
         :none => [],
       }

data/spec/cli/yardoc_spec.rb

@@ -580,11 +580,33 @@ describe YARD::CLI::Yardoc do
       mod.clear_markup_cache
       mod.const_get(:MARKUP_PROVIDERS).should_receive(:[]).with(:rdoc).and_return([{:lib => 'INVALID'}])
       log.should_receive(:warn).with(/Could not load default RDoc formatter/)
-      @yardoc.generate = true
+      @yardoc.stub(:generate) { @yardoc.options[:files] = []; true }
       @yardoc.run
       @yardoc.options[:markup].should == :none
       mod.clear_markup_cache
     end
+
+    it "should error immediately if markup for any files are missing" do
+      mod = YARD::Templates::Helpers::MarkupHelper
+      mod.clear_markup_cache
+      mod.const_get(:MARKUP_PROVIDERS).should_receive(:[]).with(:markdown).and_return([{:lib => 'INVALID'}])
+      log.should_receive(:error).with(/Missing 'INVALID' gem for Markdown formatting/)
+      files = [CodeObjects::ExtraFileObject.new('test.md', '')]
+      @yardoc.stub(:generate) { @yardoc.options[:files] = files; true }
+      @yardoc.run
+      mod.clear_markup_cache
+    end
+
+    it "should error immediately if markup for any files are missing (file markup specified in attributes)" do
+      mod = YARD::Templates::Helpers::MarkupHelper
+      mod.clear_markup_cache
+      mod.const_get(:MARKUP_PROVIDERS).should_receive(:[]).with(:markdown).and_return([{:lib => 'INVALID'}])
+      log.should_receive(:error).with(/Missing 'INVALID' gem for Markdown formatting/)
+      files = [CodeObjects::ExtraFileObject.new('test', '# @markup markdown')]
+      @yardoc.stub(:generate) { @yardoc.options[:files] = files; true }
+      @yardoc.run
+      mod.clear_markup_cache
+    end
   end
   
   describe '#run' do

data/spec/parser/c_parser_spec.rb

@@ -165,6 +165,28 @@ describe YARD::Parser::CParser do
         Registry.at('Foo#foo=').should be_writer
       end
     end
+    
+    describe 'Defining aliases' do
+      before do
+        Registry.clear
+      end
+      
+      it "should allow defining of aliases (rb_define_alias)" do
+        @contents = <<-eof
+          /* FOO */
+          VALUE foo(VALUE x) { int value = x; }
+          void Init_Foo() {
+            rb_cFoo = rb_define_class("Foo", rb_cObject);
+            rb_define_method(rb_cFoo, "foo", foo, 1);
+            rb_define_alias(rb_cFoo, "bar", "foo");
+          }
+        eof
+        parse
+        
+        Registry.at('Foo#bar').should be_is_alias
+        Registry.at('Foo#bar').docstring.should == 'FOO'
+      end
+    end
   end
 
   describe '#find_override_comment' do

data/spec/parser/source_parser_spec.rb

@@ -462,11 +462,13 @@ describe YARD::Parser::SourceParser do
     it "should convert file contents to proper encoding if coding line is present" do
       valid = []
       valid << "# encoding: sjis"
+      valid << "# encoding: utf-8"
       valid << "# xxxxxencoding: sjis"
       valid << "# xxxxxencoding: sjis xxxxxx"
       valid << "# ENCODING: sjis"
       valid << "#coDiNG: sjis"
       valid << "# -*- coding: sjis -*-"
+      valid << "# -*- coding: utf-8; indent-tabs-mode: nil"
       valid << "### coding: sjis"
       valid << "# encoding=sjis"
       valid << "# encoding:sjis"
@@ -487,7 +489,7 @@ describe YARD::Parser::SourceParser do
           File.should_receive(:read_binary).with('tmpfile').and_return(src)
           result = parser.parse("tmpfile")
           if HAVE_RIPPER && RUBY19
-            ['Shift_JIS', 'Windows-31J'].send(msg, include(
+            ['Shift_JIS', 'Windows-31J', 'UTF-8'].send(msg, include(
               result.enumerator[0].source.encoding.to_s))
           end
           result.encoding_line.send(msg) == src.split("\n").last
@@ -495,6 +497,25 @@ describe YARD::Parser::SourceParser do
       end
     end
 
+    it "should convert C file contents to proper encoding if coding line is present" do
+      valid = []
+      valid << "/* coding: utf-8 */"
+      valid << "/* -*- coding: utf-8; c-file-style: \"ruby\" -*- */"
+      valid << "// coding: utf-8"
+      valid << "// -*- coding: utf-8; c-file-style: \"ruby\" -*-"
+      invalid = []
+      {:should => valid, :should_not => invalid}.each do |msg, list|
+        list.each do |src|
+          Registry.clear
+          parser = Parser::SourceParser.new
+          File.should_receive(:read_binary).with('tmpfile.c').and_return(src)
+          result = parser.parse("tmpfile.c")
+          content = result.instance_variable_get("@content")
+          ['UTF-8'].send(msg, include(content.encoding.to_s))
+        end
+      end
+    end if RUBY19
+
     Parser::SourceParser::ENCODING_BYTE_ORDER_MARKS.each do |encoding, bom|
       it "should understand #{encoding.upcase} BOM" do
         parser = Parser::SourceParser.new
@@ -571,4 +592,4 @@ describe YARD::Parser::SourceParser do
       Registry.at('A#baz').group.should == "Group 2"
     end
   end
-end
+end

data/spec/registry_store_spec.rb

@@ -2,6 +2,7 @@ require File.join(File.dirname(__FILE__), "spec_helper")
 
 describe YARD::RegistryStore do
   before do
+    FileUtils.rm_rf("foo")
     @store = RegistryStore.new
     @serializer = Serializers::YardocSerializer.new('foo')
     Serializers::YardocSerializer.stub!(:new).and_return(@serializer)
@@ -251,4 +252,4 @@ describe YARD::RegistryStore do
       @store.destroy(true).should == true
     end
   end
-end
+end

data/spec/templates/helpers/html_helper_spec.rb

@@ -103,15 +103,28 @@ describe YARD::Templates::Helpers::HtmlHelper do
       htmlify("A\nB", :textile).should_not include("<br")
     end
     
+    it "should use hard breaks for textile_strict markup (RedCloth specific)" do
+      begin; require 'redcloth'; rescue LoadError; pending 'test requires redcloth gem' end
+      htmlify("A\nB", :textile_strict).should include("<br")
+    end
+
     it "should handle various encodings" do
       stub!(:object).and_return(Registry.root)
       Encoding.default_internal = 'utf-8' if defined?(Encoding)
       htmlify("\xB0\xB1", :text)
       # TODO: add more encoding tests
     end
+
+    it "should return pre-formatted text with :pre markup" do
+      htmlify("fo\no\n\nbar<>", :pre).should == "<pre>fo\no\n\nbar&lt;&gt;</pre>"
+    end
     
-    it "should return regular text with :none markup" do
-      htmlify("fo\no\n\nbar<>", :none).should == "fo\no<br/>bar&lt;&gt;"
+    it "should return regular text with :text markup" do
+      htmlify("fo\no\n\nbar<>", :text).should == "fo<br/>o<br/><br/>bar&lt;&gt;"
+    end
+
+    it "should return unmodified text with :none markup" do
+      htmlify("fo\no\n\nbar<>", :none).should == "fo\no\n\nbar&lt;&gt;"
     end
     
     it "should highlight ruby if markup is :ruby" do
@@ -121,8 +134,8 @@ describe YARD::Templates::Helpers::HtmlHelper do
     it "should include file and htmlify it" do
       load_markup_provider(:rdoc)
       File.should_receive(:file?).with('foo.rdoc').and_return(true)
-      File.should_receive(:read).with('foo.rdoc').and_return('= HI')
-      htmlify("{include:file:foo.rdoc}", :rdoc).gsub(/\s+/, '').should == "<p><h1>HI</h1></p>"
+      File.should_receive(:read).with('foo.rdoc').and_return('HI')
+      htmlify("{include:file:foo.rdoc}", :rdoc).gsub(/\s+/, '').should == "<p><p>HI</p></p>"
     end
     
     it "should autolink URLs (markdown specific)" do

data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb

@@ -19,9 +19,9 @@ describe YARD::Templates::Helpers::HtmlSyntaxHighlightHelper do
       type = Parser::SourceParser.parser_type
       Parser::SourceParser.parser_type = :ruby18
       should_receive(:options).and_return(:no_highlight => false)
-      expect = "<span class='def def kw'>def</span><span class='x identifier id'>x</span>
+      expect = "<span class='rubyid_def def kw'>def</span><span class='rubyid_x identifier id'>x</span>
         <span class='string val'>'x'</span><span class='plus op'>+</span>
-        <span class='regexp val'>/x/i</span><span class='end end kw'>end</span>"
+        <span class='regexp val'>/x/i</span><span class='rubyid_end end kw'>end</span>"
       result = html_syntax_highlight("def x\n  'x' + /x/i\nend")
       html_equals_string(result, expect)
       Parser::SourceParser.parser_type = type
@@ -30,7 +30,7 @@ describe YARD::Templates::Helpers::HtmlSyntaxHighlightHelper do
     it "should highlight source (ripper)" do
       should_receive(:options).and_return(:no_highlight => false)
       Parser::SourceParser.parser_type = :ruby
-      expect = "<span class='kw'>def</span> <span class='id x'>x</span>  
+      expect = "<span class='kw'>def</span> <span class='id identifier rubyid_x'>x</span>  
         <span class='tstring'><span class='tstring_beg'>'</span>
         <span class='tstring_content'>x</span><span class='tstring_end'>'</span>
         </span> <span class='op'>+</span> <span class='tstring'>

data/spec/templates/helpers/markup/rdoc_markup_spec.rb

@@ -67,7 +67,7 @@ describe YARD::Templates::Helpers::Markup::RDocMarkup do
     end
     
     it "should not apply to code blocks" do
-      fix_typewriter("<code>+hello+</code>").should == "<code>+hello+</code>"
+      fix_typewriter("<code>Hello +hello+</code>").should == "<code>Hello +hello+</code>"
     end
     
     it "should not apply to HTML tag attributes" do

data/spec/templates/helpers/markup_helper_spec.rb

@@ -46,23 +46,23 @@ describe YARD::Templates::Helpers::MarkupHelper do
     end
   
     it "should search through available markup providers for the markup type if none is set" do
-      @gen.should_receive(:eval).with('::RDiscount').and_return(mock(:bluecloth))
-      @gen.should_receive(:require).with('rdiscount').and_return(true)
+      @gen.should_receive(:eval).with('::RedcarpetCompat').and_return(mock(:bluecloth))
+      @gen.should_receive(:require).with('redcarpet').and_return(true)
       @gen.should_not_receive(:require).with('maruku')
       @gen.stub!(:options).and_return({:markup => :markdown})
       # this only raises an exception because we mock out require to avoid 
       # loading any libraries but our implementation tries to return the library 
       # name as a constant
       @gen.load_markup_provider.should == true
-      @gen.markup_provider.should == :rdiscount
+      @gen.markup_provider.should == :redcarpet
     end
   
     it "should continue searching if some of the providers are unavailable" do
+      @gen.should_receive(:require).with('redcarpet').and_raise(LoadError)
       @gen.should_receive(:require).with('rdiscount').and_raise(LoadError)
       @gen.should_receive(:require).with('kramdown').and_raise(LoadError)
       @gen.should_receive(:require).with('bluecloth').and_raise(LoadError)
       @gen.should_receive(:require).with('maruku').and_raise(LoadError)
-      @gen.should_receive(:require).with('redcarpet').and_raise(LoadError)
       @gen.should_receive(:require).with('rpeg-markdown').and_return(true)
       @gen.should_receive(:eval).with('::PEGMarkdown').and_return(true)
       @gen.stub!(:options).and_return({:markup => :markdown})

data/templates/default/fulldoc/html/css/style.css

@@ -163,7 +163,7 @@ p.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace;
 
 #content a:link, #content a:visited { text-decoration: none; color: #05a; }
 #content a:hover { background: #ffffa5; }
-.docstring { margin-right: 6em; }
+div.docstring, p.docstring { margin-right: 6em; }
 
 ul.summary {
   list-style: none;
@@ -294,7 +294,7 @@ li.r2 { background: #fafafa; }
 #filecontents pre.code, .docstring pre.code { display: block; }
 .source_code .lines { padding-right: 12px; color: #555; text-align: right; }
 #filecontents pre.code, .docstring pre.code, 
-.tags .example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
+.tags pre.example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
 pre.code { color: #000; }
 pre.code .info.file { color: #555; }
 pre.code .val { color: #036A07; }
@@ -302,21 +302,21 @@ pre.code .tstring_content,
 pre.code .heredoc_beg, pre.code .heredoc_end,
 pre.code .qwords_beg, pre.code .qwords_end,
 pre.code .tstring, pre.code .dstring { color: #036A07; }
-pre.code .fid, pre.code .id.new, pre.code .id.to_s, 
-pre.code .id.to_sym, pre.code .id.to_f, 
+pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s, 
+pre.code .rubyid_to_sym, pre.code .rubyid_to_f, 
 pre.code .dot + pre.code .id,
-pre.code .id.to_i pre.code .id.each { color: #0085FF; }
+pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
 pre.code .comment { color: #0066FF; }
 pre.code .const, pre.code .constant { color: #585CF6; }
 pre.code .symbol { color: #C5060B; }
 pre.code .kw, 
 pre.code .label,
-pre.code .id.require, 
-pre.code .id.extend,
-pre.code .id.include { color: #0000FF; }
+pre.code .rubyid_require, 
+pre.code .rubyid_extend,
+pre.code .rubyid_include { color: #0000FF; }
 pre.code .ivar { color: #318495; }
 pre.code .gvar, 
-pre.code .id.backref, 
-pre.code .id.nth_ref { color: #6D79DE; }
+pre.code .rubyid_backref, 
+pre.code .rubyid_nth_ref { color: #6D79DE; }
 pre.code .regexp, .dregexp { color: #036A07; }
 pre.code a { border-bottom: 1px dotted #bbf; }

data/templates/default/fulldoc/html/js/app.js

@@ -2,11 +2,11 @@ function createSourceLinks() {
     $('.method_details_list .source_code').
         before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
     $('.toggleSource').toggle(function() {
-       $(this).parent().next().slideDown(100);
+       $(this).parent().nextAll('.source_code').slideDown(100);
        $(this).text("Hide source");
     },
     function() {
-        $(this).parent().next().slideUp(100);
+        $(this).parent().nextAll('.source_code').slideUp(100);
         $(this).text("View source");
     });
 }
@@ -109,10 +109,10 @@ function summaryToggle() {
   $('.summary_toggle').click(function() {
     localStorage.summaryCollapsed = $(this).text();
     $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
-    var next = $(this).parent().parent().next();
+    var next = $(this).parent().parent().nextAll('ul.summary').first();
     if (next.hasClass('compact')) {
       next.toggle();
-      next.next().toggle();
+      next.nextAll('ul.summary').first().toggle();
     } 
     else if (next.hasClass('summary')) {
       var list = $('<ul class="summary compact" />');

data/templates/guide/fulldoc/html/css/style.css

@@ -57,7 +57,7 @@ a:hover { color: #060; background: #8e0; }
 #filecontents pre.code, .docstring pre.code { display: block; }
 .source_code .lines { padding-right: 12px; color: #555; text-align: right; }
 #filecontents pre.code, .docstring pre.code, 
-.tags .example { 
+.tags pre.example { 
   font-size: 0.9em;
   padding: 7px 30px;
   margin: 15px -30px;
@@ -73,21 +73,21 @@ pre.code .tstring_content,
 pre.code .heredoc_beg, pre.code .heredoc_end,
 pre.code .qwords_beg, pre.code .qwords_end,
 pre.code .tstring, pre.code .dstring { color: #036A07; }
-pre.code .fid, pre.code .id.new, pre.code .id.to_s, 
-pre.code .id.to_sym, pre.code .id.to_f, 
+pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s, 
+pre.code .rubyid_to_sym, pre.code .rubyid_to_f, 
 pre.code .dot + pre.code .id,
-pre.code .id.to_i pre.code .id.each { color: #0085FF; }
+pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
 pre.code .comment { color: #0066FF; }
 pre.code .const, pre.code .constant { color: #585CF6; }
 pre.code .symbol { color: #C5060B; }
 pre.code .kw, 
 pre.code .label,
-pre.code .id.require, 
-pre.code .id.extend,
-pre.code .id.include { color: #0000FF; }
+pre.code .rubyid_require, 
+pre.code .rubyid_extend,
+pre.code .rubyid_include { color: #0000FF; }
 pre.code .ivar { color: #318495; }
 pre.code .gvar, 
-pre.code .id.backref, 
-pre.code .id.nth_ref { color: #6D79DE; }
+pre.code .rubyid_backref, 
+pre.code .rubyid_nth_ref { color: #6D79DE; }
 pre.code .regexp, .dregexp { color: #036A07; }
 pre.code a { border-bottom: 1px dotted #bbf; }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-15 00:00:00.000000000 -04:00
+date: 2011-12-03 00:00:00.000000000 -05:00
 default_executable: 
 dependencies: []
 description: ! "    YARD is a documentation generation tool for the Ruby programming