yard 0.7.1 → 0.7.2

data/ChangeLog

@@ -1,11 +1,191 @@
+2011-06-14  Loren Segal <lsegal@soen.ca>
+
+  * ChangeLog, README.md, lib/yard.rb: 0.7.2 release
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb: Add extra spec for `{http://...}`
+  links (and fix behaviour)
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb: Support YARD style `{http://...
+  title}` links when using markdown provider that performs URL autolinking. 
+  Closes #353
+
+2011-06-13  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/parser/ruby/ruby_parser.rb, spec/parser/ruby/ruby_parser_spec.rb:
+  Print correct constant values when using %w() arrays  Closes #348
+
+  * lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb: Use capitalized tag name
+  if title is not provided in --tag  Closes #352
+
+  * .gitignore, Gemfile: Add Gemfile for Bundler support
+
+2011-06-12  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/tags/library.rb: Fix typo in transitive_tags docs
+
+2011-06-11  Michael S. Klishin <michael@novemberain.com>
+
+  * spec/registry_spec.rb: Eliminate deadlocks for thread-local spec group on
+  1.8.7-p334  Ruby 1.8.7 seems to treat empty while loops "specially". As soon
+  as a Kernel#puts call or a variable assignment happens in the while loop
+  body, deadlocks are gone. Note that synchronization alone wasn't sufficient.
+
+2011-06-07  Akzhan Abdulin <akzhan.abdulin@gmail.com>
+
+  * lib/yard/autoload.rb: __p method should not depend on / file path
+  separator. Actually it has only one parameter.
+
+2011-06-06  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/cli/yardoc.rb, spec/cli/yardoc_spec.rb,
+  spec/templates/onefile_spec.rb, templates/default/onefile/html/setup.rb: Fix
+  readme logic using --one-file and add tests
+
+  * templates/default/fulldoc/html/setup.rb: No longer need to add
+  files/readmes in templates (done inside CLI::Yardoc)
+
+  * spec/cli/yardoc_spec.rb: Stub out README in extra files spec
+
+2011-06-05  Nick Plante <nap@zerosum.org>
+
+  * lib/yard/cli/yardoc.rb: ensure that readme isn't duplicated in file list
+
+  * lib/yard/cli/yardoc.rb, lib/yard/server/commands/frames_command.rb,
+  lib/yard/server/commands/library_command.rb, spec/cli/yardoc_spec.rb: Fix
+  readme option display for YARD server (frames)
+
+2011-06-03  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/parser/ruby/legacy/statement_list.rb,
+  spec/handlers/examples/method_handler_001.rb.txt,
+  spec/handlers/method_handler_spec.rb: Properly handle 'def end' in legacy
+  parser  Closes #343
+
+2011-05-27  Loren Segal <lsegal@soen.ca>
+
+  * spec/cli/diff_spec.rb: Make File mocks in diff_spec.rb more resilient to
+  different environments (bundler)
+
+  * lib/yard/templates/helpers/text_helper.rb,
+  spec/templates/helpers/text_helper_spec.rb: Make overload fix work with text
+  helper as well
+
+  * lib/yard/server/commands/library_command.rb: Require 'thread' in
+  LibraryCommand  Closes #338
+
+2011-05-24  Franklin Webber <franklin.webber@gmail.com>
+
+  * lib/yard/config.rb: YARD::Config - fixed typo  Thanks Loren
+
+  * lib/yard/config.rb: YARD Configuration Documentation  Included example of
+  using the YARD::Config from the point-of-view of plugin designer.
+
+2011-05-24  Jon Wood <jon@blankpad.net>
+
+  * README.md: Fix a type in the query documentation.
+
+2011-05-23  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb,
+  .../templates/helpers/shared_signature_examples.rb: Method signature should
+  use regular return tag if @overload is empty
+
+  * lib/yard/code_objects/macro_object.rb: Fix documentation for macro
+  interpolation ($* not $&)
+
+  * lib/yard/handlers/ruby/macro_handler_methods.rb,
+  spec/handlers/examples/macro_handler_001.rb.txt,
+  spec/handlers/macro_handler_spec.rb: The @attribute tag should allow setting
+  the method name
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb: Link to correct object when
+  `@overload` tag uses different method name  Reported by @ryansobol  Closes
+  #330
+
+  * lib/yard/cli/yardoc.rb: Don't use --charset in 1.8
+
+  * spec/templates/helpers/html_helper_spec.rb: Load markup provider before
+  stubbing file so specs pass
+
+  * lib/yard/cli/server.rb: Simplify the assignment of expanded library path
+
+2011-05-23  Rob Gleeson <rob@flowof.info>
+
+  * lib/yard/cli/server.rb, spec/cli/server_spec.rb: Fix failing specs.
+
+2011-05-22  Rob Gleeson <rob@flowof.info>
+
+  * lib/yard/cli/server.rb: Resolve relative links in daemon mode.
+
+2011-05-22  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/templates/helpers/html_helper.rb,
+  spec/templates/helpers/html_helper_spec.rb: Handles the valid 'utf8' locale
+  value as 'utf-8'  Supporting #317
+
+  * spec/templates/helpers/html_helper_spec.rb: Stub ENV for charset test 
+  Closes #317
+
+2011-05-21  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/parser/source_parser.rb: Fix documentation claiming that
+  SourceParser.parse returns a parser object; it returns void.  Closes #325
+
+  * spec/cli/command_spec.rb: Add more tests for unrecognized options in yard
+  commands
+
+  * lib/yard/cli/command.rb, spec/cli/command_spec.rb: Try to continue parsing
+  options if one argument failed to parse
+
+2011-05-20  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/cli/yardoc.rb: Remove default parsing of --help/--version in
+  OptionParser so that yardoc --help shows up again  Closes #324
+
+  * lib/yard/handlers/ruby/legacy/macro_handler.rb,
+  lib/yard/handlers/ruby/macro_handler.rb,
+  spec/handlers/examples/macro_handler_001.rb.txt,
+  spec/handlers/macro_handler_spec.rb: Enable DSL/macro detection in top level
+  namespace  Closes #321
+
+  * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Don't enforce
+  K&R C syntax when searching for CRuby function bodies  Closes #320
+
+  * lib/yard/parser/c_parser.rb, spec/parser/c_parser_spec.rb: Refactor C
+  Parser tests and ensure that comments are no longer part of the method body
+
+  * lib/yard/handlers/base.rb, lib/yard/logging.rb,
+  lib/yard/parser/c_parser.rb: Add Logger#warn_no_continuations to refactor the
+  multiple calls to this global warning switch
+
+  * lib/yard/autoload.rb: Add NamespaceMissingError to autoload
+
+2011-05-20  Rob Gleeson <rob@flowof.info>
+
+  * lib/yard/cli/yardoc.rb: Provide a solution to issue #322.  Ask 'Encoding'
+  does it respond to default_external= before assuming that it does.
+
 2011-05-18  Loren Segal <lsegal@soen.ca>
 
+  * lib/yard/cli/stats.rb, spec/parser/base_spec.rb: Fix some incompatible
+  specs on Rubinius
+
+  * .gitignore: Ignore .rbc files from project
+
   * ChangeLog, lib/yard.rb: Update version / changelog
 
   * README.md: Bump to 0.7.1
 
   * spec/code_objects/constants_spec.rb: Fix a spec
 
+2011-05-18  Simone Carletti <weppos@weppos.net>
+
+  * docs/GettingStarted.md: Fixed broken links.
+
 2011-05-17  Loren Segal <lsegal@soen.ca>
 
   * templates/default/fulldoc/html/setup.rb: Oops, yard server sets @items

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.1 (codename "Heroes")    
-**Release Date**: May 18th 2011    
+**Latest Version**: 0.7.2 (codename "Heroes")    
+**Release Date**: June 14th 2011    
 
 Synopsis
 --------
@@ -202,7 +202,7 @@ 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 '@rturn && @param'
+    --query '@return && @param'
     
 For more information about the query syntax, see the {YARD::Verifier} class.
 
@@ -289,6 +289,15 @@ More options can be seen by typing `yard-graph --help`, but here is an example:
 Changelog
 ---------
 
+- **June.14.11**: 0.7.2 release
+    - Fix `yard --help` not showing proper output
+    - YARD now expands path to `.yardoc` file in daemon mode for server (#328)
+    - Fix `@overload` tag linking to wrong method (#330)
+    - Fix incorrect return type when using `@macro` (#334)
+    - YARD now requires 'thread' to support RubyGems 1.7+ (#338)
+    - Fix bug in constant documentation when using `%w()` (#348)
+    - Fix YARD style URL links when using autolinking markdown (#353)
+
 - **May.18.11**: 0.7.1 release
     - Fixes a bug in `yard server` not displaying class list properly.
 

data/docs/GettingStarted.md

@@ -181,7 +181,7 @@ 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 
+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
@@ -191,7 +191,7 @@ The most common is the `attr_accessor` method, which of course has built-in
 support in YARD. However, frameworks and libraries often expose custom
 methods that perform similar metaprogramming tasks, and it is often useful
 to document their functionality in your application. Consider the `property`
-method in a project like {http://datamapper.org DataMapper}, which creates
+method in a project like [DataMapper](http://datamapper.org), which creates
 a typed attribute for a database model. The code might look like:
 
     class Post

data/lib/yard.rb

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

data/lib/yard/autoload.rb

@@ -1,5 +1,5 @@
 # @private
-def __p(*path) File.join(YARD::ROOT, 'yard', *path) end
+def __p(path) File.join(YARD::ROOT, 'yard', *path.split('/')); end
 
 module YARD
   module CLI # Namespace for command-line interface components
@@ -101,6 +101,7 @@ module YARD
     end
 
     autoload :Base,                       __p('handlers/base')
+    autoload :NamespaceMissingError,      __p('handlers/base')
     autoload :Processor,                  __p('handlers/processor')
   end
 

data/lib/yard/cli/command.rb

@@ -50,8 +50,10 @@ module YARD
       # @return [void]
       def parse_options(opts, args)
         opts.parse!(args)
-      rescue OptionParser::InvalidOption => e
-        log.warn "Unrecognized/#{e.message}"
+      rescue OptionParser::ParseError => err
+        log.warn "Unrecognized/#{err.message}"
+        args.shift if args.first && args.first[0,1] != '-'
+        retry
       end
 
       # Loads a Ruby script. If +Config.options[:safe_mode]+ is enabled,

data/lib/yard/cli/server.rb

@@ -68,6 +68,7 @@ module YARD
         (0...args.size).step(2) do |index|
           library, yardoc = args[index], args[index + 1]
           yardoc ||= '.yardoc'
+          yardoc = File.expand_path(yardoc)
           if File.exist?(yardoc)
             libraries[library] ||= []
             libraries[library] << YARD::Server::LibraryVersion.new(library, nil, yardoc)
@@ -142,13 +143,13 @@ module YARD
         parse_options(opts, args)
 
         if args.empty? && libraries.empty?
-          if !File.exist?('.yardoc')
+          if !File.exist? File.expand_path('.yardoc')
             log.enter_level(Logger::INFO) do
               log.info "No .yardoc file found in current directory, parsing source before starting server..."
             end
             Yardoc.run('-n')
           end
-          add_libraries([File.basename(Dir.pwd), '.yardoc'])
+          add_libraries([File.basename(Dir.pwd), File.expand_path('.yardoc')])
         else
           add_libraries(args)
           options[:single_library] = false if libraries.size > 1
@@ -156,4 +157,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/cli/stats.rb

@@ -141,9 +141,9 @@ module YARD
         @total += data if data.is_a?(Integer) && undoc
         @undocumented += undoc if undoc.is_a?(Integer)
         if undoc
-          data = ("% 5s (% 5d undocumented)" % [data, undoc])
+          data = ("%5s (% 5d undocumented)" % [data, undoc])
         else
-          data = "% 5s" % data
+          data = "%5s" % data
         end
         puts("%-12s %s" % [name + ":", data])
       end

data/lib/yard/cli/yardoc.rb

@@ -186,8 +186,8 @@ module YARD
         @save_yardoc = true
         @has_markup = false
 
-        if defined?(Encoding)
-          Encoding.default_external, Encoding.default_internal = 'utf-8', 'utf-8'
+        if defined?(::Encoding) && ::Encoding.respond_to?(:default_external=)
+          ::Encoding.default_external, ::Encoding.default_internal = 'utf-8', 'utf-8'
         end
       end
 
@@ -248,15 +248,13 @@ module YARD
         self.files = ['{lib,app}/**/*.rb', 'ext/**/*.c'] if self.files.empty?
         self.files.delete_if {|x| x =~ /\A\s*\Z/ } # remove empty ones
         readme = Dir.glob('README*').first
+        readme ||= Dir.glob(files.first).first if options[:onefile]
         options[:readme] ||= CodeObjects::ExtraFileObject.new(readme) if readme
-        if options[:onefile]
-          options[:files] << options[:readme] if options[:readme]
-          readme = Dir.glob(files.first).first
-          options[:readme] = CodeObjects::ExtraFileObject.new(readme) if readme
-        end
+        options[:files].unshift(options[:readme]).uniq! if options[:readme]
+
         Tags::Library.visible_tags -= hidden_tags
         add_visibility_verifier
-        
+
         if generate && !verify_markup_options
           false
         else
@@ -355,6 +353,7 @@ module YARD
       # Parses out the yardopts/document options
       def parse_yardopts_options(*args)
         opts = OptionParser.new
+        opts.base.long.clear # HACK: why are --help and --version defined?
         yardopts_options(opts)
         begin
           opts.parse(args)
@@ -430,6 +429,7 @@ module YARD
       # @since 0.6.0
       def add_tag(tag_data, factory_method = nil)
         tag, title = *tag_data.split(':')
+        title ||= tag.capitalize
         Tags::Library.define_tag(title, tag.to_sym, factory_method)
         Tags::Library.visible_tags |= [tag.to_sym]
       end
@@ -621,7 +621,9 @@ module YARD
         opts.on('--charset ENC', 'Character set to use when parsing files ', 
                                  '  (default is system locale)') do |encoding|
           begin
-            Encoding.default_external, Encoding.default_internal = encoding, encoding
+            if defined?(Encoding) && Encoding.respond_to?(:default_external=)
+              Encoding.default_external, Encoding.default_internal = encoding, encoding
+            end
           rescue ArgumentError => e
             raise OptionParser::InvalidOption, e
           end

data/lib/yard/code_objects/macro_object.rb

@@ -80,7 +80,7 @@ module YARD
         # 
         # Interpolation rules:
         # * $0, $1, $2, ... = the Nth parameter in +call_params+
-        # * $& = the full statement source (excluding block)
+        # * $* = the full statement source (excluding block)
         # * Also supports $\{N-M} ranges, as well as negative indexes on N or M
         # * Use \$ to escape the variable name in a macro.
         # 
@@ -88,7 +88,7 @@ module YARD
         #   @param [Array<String>] call_params the method name and parameters
         #     to the method call. These arguments will fill \$0-N
         #   @param [String] full_source the full source line (excluding block) 
-        #     interpolated as \$&
+        #     interpolated as \$*
         #   @param [String] block_source Currently unused. Will support 
         #     interpolating the block data as a variable.
         #   @return [String] the expanded macro data

data/lib/yard/config.rb

@@ -45,7 +45,41 @@ module YARD
   # loaded with safe mode on, because plugins are properly namespaced with
   # a 'yard-' prefix, must be installed as a gem, and therefore cannot be
   # touched by the user. To specify safe mode, use the +safe_mode+ key.
-  #
+  # 
+  # == Plugin Specific Configuration
+  # 
+  # Additional settings can be defined within the configuration file
+  # specifically to provide configuration for a plugin. A plugin that utilizes
+  # the YARD configuration is strongly encouraged to utilize namespacing of
+  # their configuration content.
+  # 
+  #     !!!yaml
+  #     load_plugins: true # Auto-load plugins when YARD starts
+  #     ignored_plugins:
+  #       - yard-broken
+  #       - broken2 # yard- prefix not necessary
+  #     autoload_plugins:
+  #       - yard-rspec
+  #     # Plugin Specific Configuration
+  #     yard-sample-plugin:
+  #       show-results-inline: true
+  # 
+  # As the configuration is available system wide, it can be
+  # accessed within the plugin code.
+  # 
+  # 
+  #     if YARD::Config.options['yard-sample-plugin'] and
+  #       YARD::Config.options['yard-sample-plugin']['show-results-inline']
+  #       # ... perform the action that places the results inline ...
+  #     else
+  #       # ... do the default behavior of not showing the results inline ...
+  #     end
+  # 
+  # When accessing the configuration, be aware that this file is user managed
+  # so configuration keys and values may not be present. Make no assumptions and
+  # instead ensure that you check for the existence of keys before proceeding to
+  # retrieve values.
+  # 
   # @since 0.6.2
   # @see options
   class Config

data/lib/yard/handlers/base.rb

@@ -478,11 +478,7 @@ module YARD
         end
 
         unless CONTINUATIONS_SUPPORTED
-          unless $NO_CONTINUATION_WARNING
-            $NO_CONTINUATION_WARNING = true
-            log.warn "JRuby/MacRuby/Rubinius do not implement Kernel#callcc and cannot " +
-              "load files in order. You must specify the correct order manually."
-          end
+          log.warn_no_continuations
           raise NamespaceMissingError, object
         end