yard 0.8.1 → 0.8.2

data/ChangeLog

@@ -1,3 +1,195 @@
+2012-06-07  Loren Segal <lsegal@soen.ca>
+
+  * ChangeLog, README.md, lib/yard.rb: Bump to version 0.8.2
+
+2012-06-06  Loren Segal <lsegal@soen.ca>
+
+  * spec/i18n/locale_spec.rb: Fix Locale spec to not use disk
+
+  * lib/yard/i18n/locale.rb: Update Locale documentation
+
+  * lib/yard/i18n/locale.rb: Fix documentation typo
+
+2012-06-05  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/server/doc_server_serializer.rb,
+  .../templates/default/fulldoc/html/js/live.js,
+  .../default/method_details/html/permalink.erb,
+  .../templates/default/method_details/html/setup.rb,
+  spec/templates/examples/module001.html,
+  spec/templates/examples/module002.html,
+  spec/templates/examples/module003.html,
+  spec/templates/examples/module004.html, spec/templates/module_spec.rb,
+  .../default/module/html/attribute_details.erb: Make permalinks work for
+  embedded mixins  Fixes #540
+
+  * lib/yard/server/commands/base.rb: Ensure that server does not serialize
+  output to disk by default
+
+2012-05-30  Loren Segal <lsegal@soen.ca>
+
+  * spec/cli/yri_spec.rb: Add test to yri to ensure serialization occurs
+
+  * lib/yard/cli/graph.rb, lib/yard/templates/engine.rb,
+  lib/yard/templates/template_options.rb: Change TemplateOptions#serialize
+  default to true  Only serializer option is required to produce output. This
+  is pre-0.8.0 behaviour and is needed for backward compatibility.  References
+  #548
+
+  * lib/yard/cli/graph.rb, lib/yard/templates/template_options.rb: Move
+  verifier to TemplateOptions
+
+  * lib/yard/handlers/base.rb,
+  lib/yard/handlers/ruby/class_condition_handler.rb,
+  .../ruby/legacy/class_condition_handler.rb,
+  lib/yard/handlers/ruby/visibility_handler.rb,
+  spec/handlers/class_condition_handler_spec.rb,
+  .../examples/class_condition_handler_001.rb.txt: Accept visibility in
+  push_state and push visibility state in class condition handlers  Fixes #551
+
+2012-05-28  Loren Segal <lsegal@soen.ca>
+
+  * Rakefile: Remove sudo from install task
+
+  * lib/yard/handlers/c/handler_methods.rb, lib/yard/parser/c/c_parser.rb,
+  spec/parser/c_parser_spec.rb: Fix issue with C parser not properly parsing
+  macros with arg## syntax
+
+2012-05-22  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/handlers/ruby/legacy/mixin_handler.rb,
+  lib/yard/handlers/ruby/mixin_handler.rb: Ensure that Registry resolution
+  picks a module when parsing a mixin.  Fixes #545
+
+  * lib/yard/code_objects/proxy.rb, lib/yard/globals.rb, lib/yard/registry.rb,
+  lib/yard/registry_store.rb, lib/yard/serializers/yardoc_serializer.rb,
+  spec/code_objects/proxy_spec.rb, spec/handlers/c/class_handler_spec.rb,
+  spec/handlers/mixin_handler_spec.rb: Add type initializer to Proxy and P() to
+  constrain Proxy type  Also disconnects Registry.proxy_types from Proxy class,
+  since nothing was using this besides the Proxy#type attribute itself. This
+  change modifies a test and no longer allows two separate Proxy objects to
+  maintain the same type information. Proxy type information is stored locally
+  to the proxy object, and no longer tracked in the Registry.  Deprecates
+  proxy_types method and tracking in Registry and RegistryStore
+
+  * lib/yard/registry.rb, spec/registry_spec.rb: Ensure that resolve returns
+  proxy fallback with supplied type set
+
+  * lib/yard/registry.rb, spec/registry_spec.rb: Add type verification to
+  Registry.resolve to ensure resolve returns object of intended type
+
+2012-05-21  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/cli/graph.rb, spec/cli/graph_spec.rb: Refactor yard graph and fix
+  regression that broke output  Fixes #548
+
+2012-05-20  Kouhei Sutou <kou@clear-code.com>
+
+  * lib/yard/i18n/text.rb, spec/i18n/text_spec.rb: i18n: add
+  YARD::I18n::Text#translate
+
+  * spec/i18n/text_spec.rb: i18n: group existing specs for
+  YARD::I18n::Text#extract_messages
+
+  * lib/yard/i18n/text.rb: i18n: extract text parse code
+
+  * Gemfile, lib/yard/autoload.rb, lib/yard/i18n/locale.rb,
+  spec/i18n/locale_spec.rb: i18n: add YARD::I18n::Locale
+
+2012-05-19  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/handlers/c/init_handler.rb, spec/handlers/c/init_handler_spec.rb:
+  Check non-Init methods for object declarations in CRuby code  Closes #543
+
+  * templates/default/fulldoc/html/js/app.js: Collapse/expand all summary lists
+  when button on any list is clicked
+
+  * lib/yard/tags/directives.rb, spec/handlers/dsl_handler_spec.rb,
+  spec/tags/directives_spec.rb: Parse parameters from signature in method
+  directive
+
+2012-05-13  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/docstring_parser.rb: Make DocstringParser attributes writable
+
+2012-05-11  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/handlers/c/override_comment_handler.rb,
+  spec/handlers/c/override_comment_handler_spec.rb: Add proper file info to
+  CRuby override comments
+
+2012-05-10  Loren Segal <lsegal@soen.ca>
+
+  * lib/yard/templates/template_options.rb: --embed-mixins should ignore
+  methods defined directly on a module
+
+  * lib/yard/registry.rb: Fix registry doc examples
+
+  * lib/yard/docstring_parser.rb: Fix doc references
+
+  * Rakefile: Remove manual loading of .travis.yml in suite task, rvm-tester
+  does this for us, now.
+
+2012-05-09  Loren Segal <lsegal@soen.ca>
+
+  * Gemfile, Rakefile: Use rvm-tester for suite task
+
+  * lib/yard/logging.rb: Only clear progress in show_progress mode
+
+  * lib/yard/cli/yardoc.rb, lib/yard/logging.rb,
+  lib/yard/parser/source_parser.rb, lib/yard/templates/engine.rb,
+  spec/parser/source_parser_spec.rb, templates/default/fulldoc/html/setup.rb:
+  Add log#progress and log#capture to log output using new progress indicator
+  in 1.9.x. Captures are not fully implemented, but will allow benchmarking of
+  data through a --time-report option in yardoc.
+
+  * lib/yard/templates/template_options.rb: Add #owner to template options
+
+  * Rakefile: No more sudo.
+
+  * lib/yard/logging.rb: Logging should be sent to STDOUT not STDERR
+
+  * lib/yard/cli/yardoc.rb: Re-generating message should be debug, not info
+
+  * Gemfile: Remove RSpec version lock in Gemfile again
+
+2012-05-08  Loren Segal <lsegal@soen.ca>
+
+  * spec/rubygems/doc_manager_spec.rb: Don't stub all FileUtils methods, just
+  important ones
+
+  * lib/yard/rubygems/doc_manager.rb: Require user_interaction since RubyGems
+  no longer does
+
+  * Gemfile: Re-lock Gemfile due to travis errors
+
+  * spec/rubygems/doc_manager_spec.rb: Require fileutils for specs
+
+  * Gemfile: Unlock rspec in Gemfile
+
+  * lib/yard/logging.rb, lib/yard/parser/source_parser.rb,
+  spec/logging_spec.rb: Parser backtraces should be logged in warn level 
+  Closes #541
+
+  * spec/rubygems/doc_manager_spec.rb: Add specs for yard doc installation
+
+  * lib/yard/rubygems/doc_manager.rb, spec/rubygems/doc_manager_spec.rb: Add
+  specs for rubygems plugin code and handle --backtrace and .yardopts files
+
+2012-05-04  Loren Segal <lsegal@soen.ca>
+
+  * spec/parser/source_parser_spec.rb: Remove and_return on
+  should_not_receive() to fix spec
+
+  * Gemfile: Update Gemfile to deal with RSpec regression rspec/rspec-mocks#132
+
+  * lib/yard/tags/default_factory.rb, spec/tags/default_factory_spec.rb: Fix
+  broken specs, references #535
+
+  * lib/yard/tags/default_factory.rb, spec/tags/default_factory_spec.rb: Fix
+  type parser to properly handle Ruby's operator and special method names 
+  Closes #535
+
 2012-05-02  Loren Segal <lsegal@soen.ca>
 
   * ChangeLog, README.md, docs/WhatsNew.md, lib/yard.rb: Bump to 0.8.1, update

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.8.1 (codename "Shave It")    
-**Release Date**: May 2nd 2012    
+**Latest Version**: 0.8.2 (codename "Shave It")    
+**Release Date**: June 7th 2012    
 
 Synopsis
 --------
@@ -286,6 +286,13 @@ More options can be seen by typing `yard graph --help`, but here is an example:
 
 ## Changelog
 
+- **June.7.12**: 0.8.2 release
+    - Embedded mixins should ignore methods defined on module (#539)
+    - Fixed permalinks for embedded mixins in `yard server` (#540)
+    - Improve parsing in CRuby code (#543)
+    - Ensure Registry.resolve picks module when parsing mixins (#545)
+    - Respect current visibility when parsing class conditions (#551)
+
 - **May.2.12**: 0.8.1 release
     - Added `--[no-]api` switch to generate docs for API sets (see {file:docs/WhatsNew.md} for details) (#532)
     - The `yard list` command now uses cache by default (#533)

data/Rakefile

@@ -3,8 +3,6 @@ require File.dirname(__FILE__) + '/lib/yard/rubygems/specification'
 require 'rbconfig'
 
 YARD::VERSION.replace(ENV['YARD_VERSION']) if ENV['YARD_VERSION']
-WINDOWS = (RbConfig::CONFIG['host_os'] =~ /mingw|win32|cygwin/ ? true : false) rescue false
-SUDO = WINDOWS ? '' : 'sudo'
 
 task :default => :specs
 
@@ -15,20 +13,16 @@ end
 
 desc "Installs the gem"
 task :install => :gem do
-  sh "#{SUDO} gem install yard-#{YARD::VERSION}.gem --no-rdoc --no-ri"
+  sh "gem install yard-#{YARD::VERSION}.gem --no-rdoc --no-ri"
 end
 
-desc 'Run spec suite'
-task :suite do
-  ['ruby186', 'ruby18', 'ruby19', 'ruby192', 'ruby193', 'jruby'].each do |ruby|
-    2.times do |legacy|
-      next if legacy == 1 && ruby =~ /^jruby|186/
-      puts "Running specs with #{ruby}#{legacy == 1 ? ' (in legacy mode)' : ''}"
-      cmd = "#{ruby} -S rake specs SUITE=1 #{legacy == 1 ? 'LEGACY=1' : ''}"
-      puts cmd
-      system(cmd)
-    end
-  end
+begin
+require 'rvm-tester'
+RVM::Tester::TesterTask.new do |t|
+  t.bundle_install = false # don't need to do this all the time
+  t.verbose = true
+end
+rescue LoadError
 end
 
 task :travis_ci do

data/lib/yard.rb

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

data/lib/yard/autoload.rb

@@ -133,10 +133,11 @@ module YARD
   # Namespace for internationalization (i18n)
   # @since 0.8.0
   module I18n
+    autoload :Locale,          __p('i18n/locale')
+    autoload :Message,         __p('i18n/message')
+    autoload :Messages,        __p('i18n/messages')
     autoload :PotGenerator,    __p('i18n/pot_generator')
     autoload :Text,            __p('i18n/text')
-    autoload :Messages,        __p('i18n/messages')
-    autoload :Message,         __p('i18n/message')
   end
 
   # The parser namespace holds all parsing engines used by YARD.

data/lib/yard/cli/graph.rb

@@ -1,5 +1,20 @@
 module YARD
   module CLI
+    # Options to pass to the {Graph} CLI.
+    class GraphOptions < Templates::TemplateOptions
+      # @return [:dot] the default output format
+      default_attr :format, :dot
+
+      # @return [Boolean] whether to list the full class diagram
+      attr_accessor :full
+
+      # @return [Boolean] whether to show the object dependencies
+      attr_accessor :dependencies
+
+      # @return [String] any contents to pass to the digraph
+      attr_accessor :contents
+    end
+
     # A command-line utility to generate Graphviz graphs from
     # a set of objects
     #
@@ -17,8 +32,9 @@ module YARD
       # Creates a new instance of the command-line utility
       def initialize
         super
-        @serializer = YARD::Serializers::StdoutSerializer.new
-        @options = SymbolHash[:format => :dot]
+        @options = GraphOptions.new
+        options.reset_defaults
+        options.serializer = YARD::Serializers::StdoutSerializer.new
       end
 
       def description
@@ -35,10 +51,12 @@ module YARD
         Registry.load
         optparse(*args)
 
-        contents = objects.map {|o| o.format(options) }.join("\n")
-        Templates::Engine.render(:format => :dot, :type => :layout,
-          :verifier => @verifier, :serializer => @serializer,
-          :contents => contents)
+        contents = objects.map do |o|
+          o.format(options.merge(:serialize => false))
+        end.join("\n")
+        opts = {:type => :layout, :contents => contents}
+        options.update(opts)
+        Templates::Engine.render(options)
       end
 
       private
@@ -80,18 +98,18 @@ module YARD
         opts.separator "Output options:"
 
         opts.on('--dot [OPTIONS]', 'Send the results directly to `dot` with optional arguments.') do |dotopts|
-          @serializer = Serializers::ProcessSerializer.new('dot ' + dotopts.to_s)
+          options.serializer = Serializers::ProcessSerializer.new('dot ' + dotopts.to_s)
         end
 
         opts.on('-f', '--file [FILE]', 'Writes output to a file instead of stdout.') do |file|
-          @serializer = Serializers::FileSystemSerializer.new(:basepath => '.', :extension => nil)
-          @serializer.instance_eval "def serialized_path(object) #{file.inspect} end"
+          options.serializer = Serializers::FileSystemSerializer.new(:basepath => '.', :extension => nil)
+          options.serializer.instance_eval "def serialized_path(object) #{file.inspect} end"
         end
 
         common_options(opts)
         parse_options(opts, args)
 
-        @verifier = Verifier.new("object.type != :method || #{visibilities.uniq.inspect}.include?(object.visibility)")
+        options.verifier = Verifier.new("object.type != :method || #{visibilities.uniq.inspect}.include?(object.visibility)")
         if args.first
           @objects = args.map {|o| Registry.at(o) }.compact
         else

data/lib/yard/cli/yardoc.rb

@@ -241,6 +241,7 @@ module YARD
       #   contains a single nil value, skip calling of {#parse_arguments}
       # @return [void]
       def run(*args)
+        log.show_progress = true
         if args.size == 0 || !args.first.nil?
           # fail early if arguments are not valid
           return unless parse_arguments(*args)
@@ -269,6 +270,8 @@ module YARD
         end
 
         true
+      ensure
+        log.show_progress = false
       end
 
       # Parses commandline arguments
@@ -347,7 +350,7 @@ module YARD
           if checksums && serialized && !object.files.any? {|f, line| changed_files.include?(f) }
             true
           else
-            log.info "Re-generating object #{object.path}..."
+            log.debug "Re-generating object #{object.path}..."
             false
           end
         end

data/lib/yard/code_objects/proxy.rb

@@ -25,7 +25,7 @@ module YARD
       #
       # @raise [ArgumentError] if namespace is not a NamespaceObject
       # @return [Proxy] self
-      def initialize(namespace, name)
+      def initialize(namespace, name, type = nil)
         namespace = Registry.root if !namespace || namespace == :root
 
         if name =~ /^#{NSEPQ}/
@@ -46,6 +46,7 @@ module YARD
         @namespace = namespace
         @obj = nil
         @imethod ||= nil
+        self.type = type
 
         if @namespace.is_a?(ConstantObject)
           @origname = nil # forget these for a constant
@@ -90,19 +91,7 @@ module YARD
         if obj = to_obj
           obj.path
         else
-          if @namespace.root?
-            (@imethod ? ISEP : "") + name.to_s
-          elsif @origname
-            if @origname =~ /^[A-Z]/
-              @origname
-            else
-              [namespace.path, @origname].join
-            end
-          elsif name.to_s =~ /^[A-Z]/ # const
-            name.to_s
-          else # class meth?
-            [namespace.path, name.to_s].join(CSEP)
-          end
+          proxy_path
         end
       end
       alias to_s path
@@ -168,14 +157,14 @@ module YARD
         if obj = to_obj
           obj.type
         else
-          Registry.proxy_types[path] || :proxy
+          @type || :proxy
         end
       end
 
       # Allows a parser to infer the type of the proxy by its path.
       # @param [#to_sym] type the proxy's inferred type
       # @return [void]
-      def type=(type) Registry.proxy_types[path] = type.to_sym end
+      def type=(type) @type = type ? type.to_sym : nil end
 
       # @return [Boolean]
       def instance_of?(klass)
@@ -235,7 +224,7 @@ module YARD
       # @return [Base, nil] the registered code object or nil
       def to_obj
         return @obj if @obj
-        if @obj = Registry.resolve(@namespace, (@imethod ? ISEP : '') + @name.to_s)
+        if @obj = Registry.resolve(@namespace, (@imethod ? ISEP : '') + @name.to_s, false, false, @type)
           if @origname && @origname.include?("::") && !@obj.path.include?(@origname)
             # the object's path should include the original proxy namespace,
             # otherwise it's (probably) not the right object.
@@ -247,6 +236,22 @@ module YARD
         end
         @obj
       end
+
+      def proxy_path
+        if @namespace.root?
+          (@imethod ? ISEP : "") + name.to_s
+        elsif @origname
+          if @origname =~ /^[A-Z]/
+            @origname
+          else
+            [namespace.path, @origname].join
+          end
+        elsif name.to_s =~ /^[A-Z]/ # const
+          name.to_s
+        else # class meth?
+          [namespace.path, name.to_s].join(CSEP)
+        end
+      end
     end
   end
 end