yard 0.8.7.4 → 0.8.7.5

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

@@ -71,13 +71,41 @@ class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
 
   def format_args
     args = statement.parameters
+
     params = []
-    params += args.required_params.map {|a| [a.source, nil] } if args.required_params
-    params += args.optional_params.map {|a| [a[0].source, a[1].source] } if args.optional_params
-    params << ["*" + args.splat_param.source, nil] if args.splat_param
-    params << ["**" + args.keyword_param.source, nil] if args.keyword_param
-    params += args.required_end_params.map {|a| [a.source, nil] } if args.required_end_params
-    params << ["&" + args.block_param.source, nil] if args.block_param
+
+    if args.unnamed_required_params
+      params += args.unnamed_required_params.map { |a| [a.source, nil] }
+    end
+
+    if args.unnamed_optional_params
+      params += args.unnamed_optional_params.map do |a|
+        [a[0].source, a[1].source]
+      end
+    end
+
+    if args.splat_param
+      params << ['*' + args.splat_param.source, nil]
+    end
+
+    if args.unnamed_end_params
+      params += args.unnamed_end_params.map { |a| [a.source, nil] }
+    end
+
+    if args.named_params
+      params += args.named_params.map do |a|
+        [a[0].source, a[1] ? a[1].source : nil]
+      end
+    end
+
+    if args.double_splat_param
+      params << ['**' + args.double_splat_param.source, nil]
+    end
+
+    if args.block_param
+      params << ['&' + args.block_param.source, nil]
+    end
+
     params
   end
 

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

@@ -24,8 +24,19 @@ class YARD::Handlers::Ruby::PrivateClassMethodHandler < YARD::Handlers::Ruby::Ba
   def privatize_class_method(node)
     if node.literal?
       method = Proxy.new(namespace, node[0][0][0], :method)
-      ensure_loaded!(method)
-      method.visibility = :private
+      
+      # Proxy will not have a #visibility method when handling inherited class methods
+      # like :new, yet "private_class_method :new" is valid Ruby syntax. Therefore
+      # if Proxy doesn't respond to #visibility, the object should be skipped.
+      # 
+      # However, it is important to note that classes can be reopened, and
+      # private_class_method can be called inside these reopened classes.
+      # Therefore when encountering private_class_method, all of the files need
+      # to be parsed before checking if Proxy responds to #visibility. If this
+      # is not done, it is possible that class methods may be incorrectly marked
+      # public/private.
+      parser.parse_remaining_files
+      method.visibility = :private if method.respond_to? :visibility
     else
       raise UndocumentableError, "invalid argument to private_class_method: #{node.source}"
     end

data/lib/yard/i18n/pot_generator.rb

@@ -235,6 +235,8 @@ EOH
       def extract_tag_documents(tag)
         extract_tag_name(tag)
         extract_tag_text(tag)
+
+        extract_documents(tag) if Tags::OverloadTag === tag
       end
 
       def extract_tag_name(tag)

data/lib/yard/logging.rb

@@ -26,7 +26,7 @@ module YARD
       return false if YARD.ruby18? # threading is too ineffective for progress support
       return false if YARD.windows? # windows has poor ANSI support
       return false unless io.tty? # no TTY support on IO
-      return false if level > WARN # no progress in verbose/debug modes
+      return false unless level > INFO # no progress in verbose/debug modes
       @show_progress
     end
     attr_writer :show_progress

data/lib/yard/parser/ruby/ast_node.rb

@@ -376,18 +376,46 @@ module YARD
       end
 
       class ParameterNode < AstNode
-        def required_params; self[0] end
-        def required_end_params; self[3] end
-        def splat_param; self[2] ? self[2][0] : nil end
-        def block_param; self[-1] ? self[-1][0] : nil end
-        def optional_params
-          optional = self[1] || []
-          if self[-3] && self[-3][0] && self[-3][0].type == :default_arg
-            optional += self[-3]
+        def unnamed_required_params
+          self[0]
+        end
+
+        def unnamed_optional_params
+          return @unnamed_optional_params if defined?(@unnamed_optional_params)
+
+          params = self[1] || []
+          if self[-3] && self[-3][0] && self[-3][0].type == :unnamed_optional_arg
+            params += self[-3]
+          end
+
+          @unnamed_optional_params = params.empty? ? nil : params
+        end
+
+        def named_params
+          return @named_params if defined?(@named_params)
+
+          if YARD.ruby2? && self[-3] && self[-3][0] && self[-3][0].type == :named_arg
+            @named_params = self[-3]
+          else
+            @named_params = nil
           end
-          optional.empty? ? nil : optional
         end
-        def keyword_param; YARD.ruby2? ? self[-2] : nil end
+
+        def splat_param
+          self[2] ? self[2][0] : nil
+        end
+
+        def unnamed_end_params
+          self[3]
+        end
+
+        def double_splat_param
+          YARD.ruby2? ? self[-2] : nil
+        end
+
+        def block_param
+          self[-1] ? self[-1][0] : nil
+        end
       end
 
       class MethodCallNode < AstNode
@@ -396,7 +424,13 @@ module YARD
 
         def method_name(name_only = false)
           name = self[index_adjust]
-          name_only ? name.jump(:ident).first.to_sym : name
+          if name == :call
+            nil
+          elsif name_only && Array === name
+            name.jump(:ident).first.to_sym
+          else
+            name
+          end
         end
 
         def parameters(include_block_param = true)

data/lib/yard/parser/ruby/ruby_parser.rb

@@ -452,21 +452,23 @@ module YARD
 
         def on_params(*args)
           args.map! do |arg|
-            if arg.class == Array
-              if arg.first.class == Array
-                arg.map! do |sub_arg|
-                  if sub_arg.class == Array
-                    AstNode.new(:default_arg, sub_arg, :listline => lineno..lineno, :listchar => charno..charno)
-                  else
-                    sub_arg
-                  end
+            next arg unless arg.class == Array
+
+            if arg.first.class == Array
+              arg.map! do |sub_arg|
+                next sub_arg unless sub_arg.class == Array
+                if sub_arg[0].type == :label
+                  type = :named_arg
+                else
+                  type = :unnamed_optional_arg
                 end
+                AstNode.new(type, sub_arg, :listline => lineno..lineno, :listchar => charno..charno)
               end
-              AstNode.new(:list, arg, :listline => lineno..lineno, :listchar => charno..charno)
-            else
-              arg
             end
+
+            AstNode.new(:list, arg, :listline => lineno..lineno, :listchar => charno..charno)
           end
+
           ParameterNode.new(:params, args, :listline => lineno..lineno, :listchar => charno..charno)
         end
 
@@ -503,7 +505,8 @@ module YARD
 
           hash_flag = $1 == '##' ? true : false
 
-          if append_comment && @comments_last_column && @comments_last_column == column
+          if append_comment && @comments_last_column &&
+              @comments_last_column == column && comment_starts_line?(ch)
             @comments.delete(lineno - 1)
             @comments_flags[lineno] = @comments_flags[lineno - 1]
             @comments_flags.delete(lineno - 1)
@@ -542,6 +545,15 @@ module YARD
           raise ParserSyntaxError, "syntax error in `#{file}`:(#{lineno},#{column}): #{msg}"
         end
 
+        def comment_starts_line?(charno)
+          (charno-1).downto(0) do |i|
+            ch = @source[i]
+            break if ch == "\n"
+            return false if ch != " " && ch != "\t"
+          end
+          true
+        end
+
         def insert_comments
           root.traverse do |node|
             next if node.type == :comment || node.type == :list || node.parent.type != :list

data/lib/yard/rake/yardoc_task.rb

@@ -14,6 +14,10 @@ module YARD
       # @return [Array<String>] the options passed to the commandline utility
       attr_accessor :options
 
+      # Options to pass to {CLI::Stats}
+      # @return [Array<String>] the options passed to the stats utility
+      attr_accessor :stats_options
+
       # The Ruby source files (and any extra documentation files separated by '-')
       # to process.
       # @example Task files assignment
@@ -46,11 +50,13 @@ module YARD
       def initialize(name = :yard)
         @name = name
         @options = []
+        @stats_options = []
         @files = []
 
         yield self if block_given?
         self.options +=  ENV['OPTS'].split(/[ ,]/) if ENV['OPTS']
         self.files   += ENV['FILES'].split(/[ ,]/) if ENV['FILES']
+        self.options << '--no-stats' unless self.stats_options.empty?
 
         define
       end
@@ -66,9 +72,10 @@ module YARD
           yardoc = YARD::CLI::Yardoc.new
           yardoc.options[:verifier] = verifier if verifier
           yardoc.run *(options + files)
+          YARD::CLI::Stats.run(*(stats_options + ['--use-cache'])) unless stats_options.empty?
           after.call if after.is_a?(Proc)
         end
       end
     end
   end
-end
+end

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

@@ -118,9 +118,12 @@ module YARD
         end
 
         def not_prepared
-          self.caching = false
           options.update(:template => :doc_server, :type => :processing)
-          [202, {'Content-Type' => 'text/html'}, [render]]
+          self.caching = false
+          self.status = 202
+          self.body = render
+          self.headers = {'Content-Type' => 'text/html'}
+          [status, headers, [body]]
         end
 
         # Hack to load a custom fulldoc template object that does

data/lib/yard/server/templates/default/layout/html/breadcrumb.erb

@@ -1,5 +1,5 @@
 <form class="search" method="get" action="/<%= base_path(router.search_prefix) %>">
-  Search: <input name="q" type="search" placeholder="Search" id="search_box" size="30" value="<%= @query %>" />
+  Search: <input name="q" type="search" placeholder="Search" id="search_box" size="30" value="<%= h @query %>" />
 </form>
 <script type="text/javascript" charset="utf-8">
   $(function() {

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

@@ -8,7 +8,8 @@
     <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: "<%= router.request.path %>" + (process ? "?process=true" : ""), statusCode: { 200: function() { window.location = "<%= @path %>"; } } });
+        $.ajax({cache: false, url: "<%= router.request.path %>" + (process ? "?process=true" : ""),
+          statusCode: { 200: function() { window.location.reload(true); } } });
         setTimeout('checkPage()', 2000);
       }
       function setFade() {

data/lib/yard/tags/library.rb

@@ -78,8 +78,6 @@ module YARD
         # @example
         #   YARD::Tags::Library.default_factory = MyFactory
         #
-        # @param [Class, Object] factory the factory that parses all tags
-        #
         # @see DefaultFactory
         def default_factory
           @default_factory ||= DefaultFactory.new

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

@@ -61,7 +61,8 @@ module YARD
           provider.new(text, :autolink).to_html
         elsif provider.to_s == 'RedcarpetCompat'
           provider.new(text, :no_intraemphasis, :gh_blockcode,
-                             :fenced_code, :autolink).to_html
+                             :fenced_code, :autolink, :tables,
+                             :lax_spacing).to_html
         else
           provider.new(text).to_html
         end
@@ -267,7 +268,7 @@ module YARD
             title = h(object.relative_path(obj))
           end
         else
-          title = h(obj.to_s)
+          title = h(obj.title)
         end
         return title unless serializer
         return title if obj.is_a?(CodeObjects::Proxy)
@@ -327,6 +328,7 @@ module YARD
         objpath = serializer.serialized_path(obj)
         return link unless objpath
 
+        relative = false if object == Registry.root
         if relative
           fromobj = object
           if object.is_a?(CodeObjects::Base) &&

data/lib/yard/templates/template.rb

@@ -314,11 +314,11 @@ module YARD
 
       # Calls the ERB file from the last inherited template with {#section}.erb
       #
-      # @param [Symbol, String] section if provided, uses a specific section name
+      # @param [Symbol, String] sect if provided, uses a specific section name
       # @return [String] the rendered ERB file in any of the inherited template
       #   paths.
-      def superb(section = section, &block)
-        filename = self.class.find_nth_file(erb_file_for(section), 2)
+      def superb(sect = section, &block)
+        filename = self.class.find_nth_file(erb_file_for(sect), 2)
         return "" unless filename
         method_name = ErbCache.method_for(filename) { erb_with(IO.read(filename), filename) }
         send(method_name, &block)

data/lib/yard/version.rb

@@ -1,3 +1,3 @@
 module YARD
-  VERSION = '0.8.7.4'
+  VERSION = '0.8.7.5'
 end

data/spec/cli/yardoc_spec.rb

@@ -320,7 +320,7 @@ describe YARD::CLI::Yardoc do
 
         CodeObjects::ExtraFileObject.stub!(:new).with('extra_file1').and_return(extra_file_object1)
         CodeObjects::ExtraFileObject.stub!(:new).with('extra_file2').and_return(extra_file_object2)
-        Dir.stub!(:glob).with('README*').and_return([])
+        Dir.stub!(:glob).with('README{,*[^~]}').and_return([])
         File.stub!(:file?).with('extra_file1').and_return(true)
         File.stub!(:file?).with('extra_file2').and_return(true)
         @yardoc.run('--locale=fr', '-', 'extra_file1', 'extra_file2')
@@ -562,7 +562,7 @@ describe YARD::CLI::Yardoc do
 
   describe 'Extra file arguments' do
     it "should accept extra files if specified after '-' with source files" do
-      Dir.should_receive(:glob).with('README*').and_return([])
+      Dir.should_receive(:glob).with('README{,*[^~]}').and_return([])
       File.should_receive(:file?).with('extra_file1').and_return(true)
       File.should_receive(:file?).with('extra_file2').and_return(true)
       File.should_receive(:read).with('extra_file1').and_return('')
@@ -575,14 +575,14 @@ describe YARD::CLI::Yardoc do
     end
 
     it "should accept files section only containing extra files" do
-      Dir.should_receive(:glob).with('README*').and_return([])
+      Dir.should_receive(:glob).with('README{,*[^~]}').and_return([])
       @yardoc.parse_arguments *%w( - LICENSE )
       @yardoc.files.should == %w( {lib,app}/**/*.rb ext/**/*.c )
       @yardoc.options.files.should == [CodeObjects::ExtraFileObject.new('LICENSE', '')]
     end
 
     it "should accept globs as extra files" do
-      Dir.should_receive(:glob).with('README*').and_return []
+      Dir.should_receive(:glob).with('README{,*[^~]}').and_return []
       Dir.should_receive(:glob).with('*.txt').and_return ['a.txt', 'b.txt']
       File.should_receive(:read).with('a.txt').and_return('')
       File.should_receive(:read).with('b.txt').and_return('')
@@ -606,7 +606,7 @@ describe YARD::CLI::Yardoc do
     end
 
     it "should use first file as readme if no readme is specified when using --one-file" do
-      Dir.should_receive(:glob).with('README*').and_return []
+      Dir.should_receive(:glob).with('README{,*[^~]}').and_return []
       Dir.should_receive(:glob).with('lib/*.rb').and_return(['lib/foo.rb'])
       File.should_receive(:read).with('lib/foo.rb').and_return('')
       @yardoc.parse_arguments *%w( --one-file lib/*.rb )
@@ -614,7 +614,7 @@ describe YARD::CLI::Yardoc do
     end
 
     it "should use readme it exists when using --one-file" do
-      Dir.should_receive(:glob).with('README*').and_return ['README']
+      Dir.should_receive(:glob).with('README{,*[^~]}').and_return ['README']
       File.should_receive(:read).with('README').and_return('')
       @yardoc.parse_arguments *%w( --one-file lib/*.rb )
       @yardoc.options.readme.should == CodeObjects::ExtraFileObject.new('README', '')

data/spec/handlers/examples/private_class_method_handler_001.rb.txt

@@ -2,6 +2,8 @@ class A
   def self.b; end
   def self.c; end
   def self.d; end
+  def self.e; end
 
   private_class_method(:c, :d)
+  private_class_method("e")
 end

data/spec/handlers/examples/private_class_method_handler_002.rb.txt

@@ -0,0 +1,18 @@
+class SingletonClass
+  
+  # Public
+  def self.foo
+    'foo'
+  end
+  
+  # Private
+  def self.bar
+  end
+  
+  # Private from reopening class.
+  def self.baz
+  end
+  
+  private_class_method :new, :bar
+  
+end

data/spec/handlers/examples/private_class_method_handler_003.rb.txt

@@ -0,0 +1,11 @@
+class SingletonClass
+  # Reopening singleton class from
+  # private_class_method_handler_002.rb.txt
+  
+  private_class_method :baz
+  
+  # Public from reopened class.
+  def self.bat
+  end
+  
+end