yard 0.7.4 → 0.7.5

data/ChangeLog

@@ -1,3 +1,165 @@
+2012-01-31  Loren Segal <lsegal@soen.ca>
+
+  * ChangeLog, README.md, lib/yard.rb: Bump to 0.7.5
+
+  * spec/templates/examples/module003.html, spec/templates/module_spec.rb,
+  .../default/module/html/inherited_constants.erb,
+  templates/default/module/setup.rb: Don't show inherited constants if
+  overridden  Backports #474, referencing #467
+
+  * lib/yard/server/commands/library_command.rb: Verify markup options when
+  loading yard opts in server mode  Backports #456, referencing #467
+
+  * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Update tests for
+  rb_define_const(), capture definitions  Backports #443, referencing #467
+
+  * lib/yard/templates/helpers/html_helper.rb: Refactor code block parsing out
+  of htmlify
+
+2012-01-30  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb: Update tests for
+  html_syntax_highlight and minor refactor  Backports #478, #479, referencing
+  #467  Conflicts:  lib/yard/templates/helpers/html_helper.rb
+
+2012-01-30  Dominik Honnef <dominikh@fork-bomb.org>
+
+  * lib/yard/templates/helpers/html_helper.rb: make parse_lang_for_codeblock
+  return the language as a symbol, not a string
+
+  * lib/yard/templates/helpers/html_helper.rb: rename parse_lang to
+  parse_lang_for_codeblock and mark private
+
+  * lib/yard/templates/helpers/html_helper.rb: fix @return tag of
+  HtmlHelper#parse_lang
+
+  * lib/yard/templates/helpers/html_helper.rb: move parsing of !!!LANG up one
+  level to add lang classes to <pre> tags
+
+2012-01-29  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Do not copy asset inside
+  of to/ if to is directory  Backports #477, referencing #467
+
+2012-01-26  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/handlers/ruby/legacy/method_handler.rb,
+  lib/yard/handlers/ruby/method_handler.rb: Fix issue #458 for legacy handlers 
+  Backport to 0.7.x, referencing #467
+
+2012-01-25  Loren Segal <lsegal@soen.ca>
+
+  * spec/registry_spec.rb, spec/templates/class_spec.rb: Fix Debian test
+  failures in 1.9.3  Backports #397, referencing #467
+
+2012-01-21  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/parser/ruby/ruby_parser.rb, spec/parser/ruby/ruby_parser_spec.rb:
+  Fix %w() source in []/[]= parsed context.  Backports #461, referencing #467
+
+  * lib/yard/handlers/ruby/method_handler.rb,
+  spec/handlers/examples/method_handler_001.rb.txt,
+  spec/handlers/method_handler_spec.rb: Don't add default @return if a
+  @overload has @return.  Backports #458, referencing #467
+
+  * lib/yard/code_objects/base.rb, spec/code_objects/base_spec.rb: Don't
+  discard tags by (see ...).  Backports #457 referencing #467
+
+2012-01-19  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/handlers/ruby/macro_handler_methods.rb: Allow processing of macros
+  attached to Object class (via inheritance)  Backports and closes #465,
+  referencing #467
+
+  * lib/yard/handlers/ruby/macro_handler_methods.rb,
+  spec/handlers/macro_handler_spec.rb: Do not auto-detect DSL methods as method
+  objects if parameter name is not a valid method name  Backports and closes
+  #464, referencing #467
+
+  * lib/yard/registry_store.rb, spec/registry_store_spec.rb: Remove heuristics
+  that disable single object db  Closes #466 referencing #467
+
+2012-01-07  Ankur Patel <ankur.patel@ymail.com>
+
+  * templates/default/fulldoc/html/js/full_list.js: Ignoring non-printable
+  characters in search  Closes #446 referencing #467
+
+2012-01-05  Sergey Avseyev <sergey.avseyev@gmail.com>
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb: Do not escape snippets twice 
+  Markup helpers aleardy done escaping. This is actually partial revert of
+  414e53424c28129625d743e41b15556f150fe083  Closes #445 referencing #467
+
+2012-01-19  Loren Segal <lsegal@soen.ca>
+
+  * spec/templates/examples/module001.html,
+  spec/templates/examples/module003.html, spec/templates/module_spec.rb,
+  .../default/module/html/inherited_attributes.erb,
+  templates/default/module/setup.rb: Run verifier on inherited attributes list 
+  Backports #432 referencing #467  Conflicts: 
+  templates/default/module/html/inherited_attributes.erb
+
+2012-01-02  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Add support for
+  rb_path2class() in CRuby
+
+  * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Properly handle
+  parsing of nested namespace definitions  Fixes #437
+
+2012-01-01  Loren Segal <lsegal@soen.ca>
+
+  * spec/templates/examples/module003.html, spec/templates/module_spec.rb,
+  .../default/module/html/inherited_attributes.erb: Ignore overwritten
+  attributes from inherited list  Closes #442
+
+  * spec/server/rack_adapter_spec.rb: Properly shutdown adapter after rack
+  middleware specs
+
+2011-12-26  Sergey Avseyev <sergey.avseyev@gmail.com>
+
+  * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Allow aliases
+  for attributes
+
+  * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Fix attribute
+  parsing  This is the real signature for rb_define_attr(). There is only four
+  arguments.  void rb_define_attr(VALUE klass, const char *name, int read, int
+  write)
+
+2011-12-19  Loren Segal <lsegal@soen.ca>
+
+  * spec/templates/tag_spec.rb, templates/default/tags/setup.rb: Don't render
+  param tags on non-method objects  Closes #429
+
+2011-12-11  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/server/commands/library_command.rb,
+  lib/yard/server/doc_server_helper.rb,
+  lib/yard/server/doc_server_serializer.rb, lib/yard/server/rack_adapter.rb,
+  lib/yard/server/router.rb, .../doc_server/library_list/html/contents.erb,
+  .../templates/doc_server/search/html/search.erb,
+  lib/yard/server/webrick_adapter.rb, spec/server/doc_server_helper_spec.rb,
+  spec/server/doc_server_serializer_spec.rb, spec/server/router_spec.rb: Only
+  add /version/ to URLs accessed with /version/  Adds request.version_supplied
+  to detect whether the version was parsed out of the URL. Rewrote some of the
+  URL helpers and serializers to respect this new behaviour.  The biggest
+  change is that the DocServerSerializer will no longer add the /prefix to the
+  serialized_path, and it will now ignore the command passed in to the
+  constructor (which is now optional). Instead, DocServerHelper#url_for should
+  be used to generate a URL with a prefix.  Closes #426
+
+2011-12-04  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb: Be more forgiving about generated
+  HTML for code blocks
+
+2011-12-05  yuta yamada <yamada@clear-code.com>
+
+  * docs/Glossary.md, docs/Overview.md: fix-typo
+
 2011-12-03  Loren Segal <lsegal@soen.ca>
 
   * ChangeLog, README.md, docs/WhatsNew.md, lib/yard.rb: Bump to version 0.7.4

data/README.md

@@ -6,10 +6,10 @@ YARD: Yay! A Ruby Documentation Tool
 **Git**:          [http://github.com/lsegal/yard](http://github.com/lsegal/yard)   
 **Author**:       Loren Segal  
 **Contributors**: See Contributors section below    
-**Copyright**:    2007-2011    
+**Copyright**:    2007-2012    
 **License**:      MIT License    
-**Latest Version**: 0.7.4 (codename "Kennedy")    
-**Release Date**: December 2nd 2011    
+**Latest Version**: 0.7.5 (codename "Jackson")    
+**Release Date**: January 31st 2012    
 
 Synopsis
 --------
@@ -289,6 +289,23 @@ More options can be seen by typing `yard-graph --help`, but here is an example:
 Changelog
 ---------
 
+- **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)
+
 - **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)

data/docs/Glossary.md

@@ -5,8 +5,8 @@
   and class variables, though it can be extended to refer to custom functionality
   defined by a DSL (like a spec, for instance).
 
-* **Domain Specific Language (DSL)**: In the context of Ruby, a DSL is a languge
+* **Domain Specific Language (DSL)**: In the context of Ruby, a DSL is a language
   optimized for a specific domain (problem) but represented using Ruby syntax.
 
 * **Docstring (Documentation String)**: Comments associated with a code object
-  used for documentation purposes.
+  used for documentation purposes.

data/docs/Overview.md

@@ -14,7 +14,7 @@ that tools like RDoc do not do. These components are:
 This separation is a major goal of the project, and means that YARD is not *just* 
 a tool to generate HTML output. The expectation is that any subset of YARD's 
 major components may be used, extended or modified independently. YARD may be 
-used just as a data gathering tool (to parse and audit code), just as as a data 
+used just as a data gathering tool (to parse and audit code), just as a data 
 source (a webserver containing raw unformatted data about code), or just as a 
 conventional HTML documentation generation tool (like RDoc).
 

data/lib/yard.rb

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

data/lib/yard/cli/yardoc.rb

@@ -340,6 +340,7 @@ module YARD
         assets.each do |from, to|
           to = File.join(outpath, to)
           log.debug "Copying asset '#{from}' to '#{to}'"
+          from += '/.' if File.directory?(from)
           FileUtils.cp_r(from, to)
         end
       end

data/lib/yard/code_objects/base.rb

@@ -217,6 +217,8 @@ module YARD
         @visibility = :public
         @tags = []
         @docstring = Docstring.new('', self)
+        @docstring_extra = nil
+        @docstring_extra_tags = nil
         @namespace = nil
         self.namespace = namespace
         yield(self) if block_given?
@@ -353,7 +355,9 @@ module YARD
           return @docstring_extra
         when Base
           @docstring = @docstring.docstring + @docstring_extra
+          @docstring.add_tag(*@docstring_extra_tags)
           @docstring_extra = nil
+          @docstring_extra_tags = nil
         end
         @docstring
       end
@@ -368,9 +372,12 @@ module YARD
         if comments =~ /\A\s*\(see (\S+)\s*\)(?:\s|$)/
           path, extra = $1, $'
           @docstring_extra = Docstring.new(extra, self)
+          @docstring_extra_tags = Docstring === comments ? comments.tags : []
+          @docstring_extra.add_tag(*@docstring_extra_tags)
           @docstring = Proxy.new(namespace, path)
         else
           @docstring_extra = nil
+          @docstring_extra_tags = nil
           @docstring = Docstring === comments ? comments : Docstring.new(comments, self)
         end
       end

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

@@ -50,7 +50,9 @@ class YARD::Handlers::Ruby::Legacy::MethodHandler < YARD::Handlers::Ruby::Legacy
       if obj.tag(:return) && (obj.tag(:return).types || []).empty?
         obj.tag(:return).types = ['Boolean']
       elsif obj.tag(:return).nil?
-        obj.docstring.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
+        unless obj.tags(:overload).any? {|overload| overload.tag(:return) }
+          obj.docstring.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
+        end
       end
     end
 

data/lib/yard/handlers/ruby/macro_handler_methods.rb

@@ -11,7 +11,7 @@ module YARD
 
           # Look for implicit macros
           (globals.__attached_macros[caller_method] || []).each do |macro|
-            namespace.inheritance_tree.each do |obj|
+            (namespace.inheritance_tree + [P('Object')]).each do |obj|
               break(@macro = macro) if obj == macro.method_object.namespace
             end
           end
@@ -82,6 +82,7 @@ module YARD
           name = nil if name =~ /\A\s*\Z/
           name ||= call_params.first
           return unless name
+          return unless name =~ /^#{METHODNAMEMATCH}(\s|\(|$)/
           if name =~ /\A\s*([^\(; \t]+)/
             name = $1
           end

data/lib/yard/handlers/ruby/method_handler.rb

@@ -47,7 +47,9 @@ class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
       if obj.tag(:return) && (obj.tag(:return).types || []).empty?
         obj.tag(:return).types = ['Boolean']
       elsif obj.tag(:return).nil?
-        obj.docstring.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
+        unless obj.tags(:overload).any? {|overload| overload.tag(:return) }
+          obj.docstring.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
+        end
       end
     end
 

data/lib/yard/parser/c_parser.rb

@@ -12,11 +12,10 @@ module YARD
       end
 
       def parse
-        parse_modules
-        parse_classes
+        parse_namespaces
         parse_methods
-        parse_aliases
         parse_attributes
+        parse_aliases
         parse_constants
         parse_includes
       end
@@ -32,6 +31,11 @@ module YARD
       def remove_var_prefix(var)
         var.gsub(/^rb_[mc]|^[a-z_]+/, '')
       end
+      
+      # @since 0.7.5
+      def lookup_var(var)
+        @namespaces[var] || P(remove_var_prefix(var))
+      end
 
       def ensure_loaded!(object, max_retries = 1)
         return if object.is_a?(CodeObjects::RootObject)
@@ -52,9 +56,18 @@ module YARD
         end
         object
       end
+      
+      # @since 0.7.5
+      def handle_namespace(var_name, ns_type, ns_name, parent, in_module = nil)
+        case ns_type
+        when 'module'; handle_module(var_name, ns_name, in_module)
+        when 'path2class'; handle_class_lookup(var_name, ns_name)
+        else handle_class(var_name, ns_name, parent, in_module)
+        end
+      end
 
       def handle_module(var_name, mod_name, in_module = nil)
-        namespace = @namespaces[in_module] || (in_module ? P(remove_var_prefix(in_module)) : :root)
+        namespace = in_module ? lookup_var(in_module) : :root
         ensure_loaded!(namespace)
         obj = CodeObjects::ModuleObject.new(namespace, mod_name)
         obj.add_file(@file)
@@ -64,14 +77,19 @@ module YARD
 
       def handle_class(var_name, class_name, parent, in_module = nil)
         parent = nil if parent == "0"
-        namespace = @namespaces[in_module] || (in_module ? P(remove_var_prefix(in_module)) : :root)
+        namespace = in_module ? lookup_var(in_module) : :root
         ensure_loaded!(namespace)
         obj = CodeObjects::ClassObject.new(namespace, class_name)
-        obj.superclass = @namespaces[parent] || remove_var_prefix(parent) if parent
+        obj.superclass = lookup_var(parent) if parent
         obj.add_file(@file)
         find_namespace_docstring(obj)
         @namespaces[var_name] = obj
       end
+      
+      # @since 0.7.5
+      def handle_class_lookup(var_name, class_name)
+        @namespaces[var_name] = P(class_name)
+      end
 
       # @return [CodeObjects::Base]
       def handle_method(scope, var_name, name, func_name, source_file = nil)
@@ -80,7 +98,7 @@ module YARD
         else; scope = :instance
         end
 
-        namespace = @namespaces[var_name] || P(remove_var_prefix(var_name))
+        namespace = lookup_var(var_name)
         ensure_loaded!(namespace)
         obj = CodeObjects::MethodObject.new(namespace, name, scope)
         obj.add_file(@file)
@@ -102,7 +120,7 @@ module YARD
       end
       
       def handle_alias(var_name, new_name, old_name)
-        namespace = P(remove_var_prefix(var_name))
+        namespace = lookup_var(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)
@@ -124,12 +142,12 @@ module YARD
 
         namespace.aliases[new_obj] = old_meth
       end
-      
-      def handle_attribute(var_name, name, func_name, read, write, source_file = nil)
+
+      def handle_attribute(var_name, name, read, write, source_file = nil)
         values = {:read => read.to_i, :write => write.to_i}
         {:read => name, :write => "#{name}="}.each do |type, meth_name|
           next unless values[type] > 0
-          obj = handle_method(:instance, var_name, meth_name, func_name, source_file)
+          obj = handle_method(:instance, var_name, meth_name, nil, source_file)
           ensure_loaded!(obj.namespace)
           obj.namespace.attributes[:instance][name] ||= SymbolHash[:read => nil, :write => nil]
           obj.namespace.attributes[:instance][name][type] = obj
@@ -137,7 +155,8 @@ module YARD
       end
 
       def handle_constants(type, var_name, const_name, definition)
-        namespace = @namespaces[var_name]
+        namespace = lookup_var(var_name)
+        ensure_loaded!(namespace)
         obj = CodeObjects::ConstantObject.new(namespace, const_name)
         obj.value = definition
         obj.add_file(@file)
@@ -148,16 +167,10 @@ module YARD
         # "/* definition: comment */" form.  The literal ':' and '\' characters
         # can be escaped with a backslash.
         if type.downcase == 'const'
-          elements = comment.split(':')
-          new_definition = elements[0..-2].join(':')
-          if new_definition.empty? then # Default to literal C definition
-            new_definition = definition
-          else
-            new_definition.gsub!("\:", ":")
-            new_definition.gsub!("\\", '\\')
+          comment.scan(/\A\s*(.*?[^\s\\]):\s*(.+)/) do |new_value, new_comment|
+            obj.value = new_value.gsub(/\\:/, ':')
+            comment = new_comment
           end
-          new_definition.sub!(/\A(\s+)/, '')
-          comment = $1.nil? ? elements.last : "#{$1}#{elements.last.lstrip}"
         end
 
         obj.docstring = comment
@@ -335,38 +348,23 @@ module YARD
         end
       end
 
-      def parse_modules
-        @content.scan(/(\w+)\s* = \s*rb_define_module\s*
-            \(\s*"(\w+)"\s*\)/mx) do |var_name, class_name|
-          handle_module(var_name, class_name)
-        end
-
-        @content.scan(/(\w+)\s* = \s*rb_define_module_under\s*
-                  \(
-                     \s*(\w+),
-                     \s*"(\w+)"
-                  \s*\)/mx) do |var_name, in_module, class_name|
-          handle_module(var_name, class_name, in_module)
-        end
-      end
-
-      def parse_classes
+      def parse_namespaces
         # The '.' lets us handle SWIG-generated files
-        @content.scan(/([\w\.]+)\s* = \s*(?:rb_define_class|boot_defclass)\s*
+        @content.scan(/([\w\.]+)\s* = \s*(?:rb_define_(class|module)|boot_defclass|rb_(path2class))\s*
                   \(
-                     \s*"(\w+)",
-                     \s*(\w+|0)\s*
-                  \)/mx) do |var_name, class_name, parent|
-          handle_class(var_name, class_name, parent)
+                     \s*"([\w:]+)"(?:,
+                     \s*(\w+|0)\s*)?
+                  \)/mx) do |var_name, ns_type, path2class, ns_name, parent|
+          handle_namespace(var_name, path2class || ns_type, ns_name, parent)
         end
 
-        @content.scan(/([\w\.]+)\s* = \s*rb_define_class_under\s*
+        @content.scan(/([\w\.]+)\s* = \s*rb_define_(class|module)_under\s*
                   \(
                      \s*(\w+),
-                     \s*"(\w+)",
-                     \s*([\w\*\s\(\)\.\->]+)\s*  # for SWIG
-                  \s*\)/mx) do |var_name, in_module, class_name, parent|
-          handle_class(var_name, class_name, parent, in_module)
+                     \s*"(\w+)"(?:,
+                     \s*([\w\*\s\(\)\.\->]+)\s*)?  # for SWIG
+                  \s*\)/mx) do |var_name, ns_type, in_module, ns_name, parent|
+          handle_namespace(var_name, ns_type, ns_name, parent, in_module)
         end
       end
 
@@ -420,10 +418,9 @@ module YARD
         @content.scan(%r{rb_define_attr
                        \s*\(\s*([\w\.]+),
                          \s*"([^"]+)",
-                         \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
                          \s*(0|1)\s*,\s*(0|1)\s*\)
                        (?:;\s*/[*/]\s+in\s+(.+?\.[cy]))?
-                     }xm) do |var_name, name, func_name, read, write, source_file|
+                     }xm) do |var_name, name, read, write, source_file|
 
           # Ignore top-object and weird struct.c dynamic stuff
           next if var_name == "ruby_top_self"
@@ -431,15 +428,14 @@ module YARD
           next if var_name == "envtbl"
 
           var_name = "rb_cObject" if var_name == "rb_mKernel"
-          handle_attribute(var_name, name, func_name, read, write, source_file)
+          handle_attribute(var_name, name, read, write, source_file)
         end
       end
 
       def parse_includes
         @content.scan(/rb_include_module\s*\(\s*(\w+?),\s*(\w+?)\s*\)/) do |klass, mod|
           if klass = @namespaces[klass]
-            mod = @namespaces[mod] || P(remove_var_prefix(mod))
-            klass.mixins(:instance) << mod
+            klass.mixins(:instance) << lookup_var(mod)
           end
         end
       end