yard 0.8.7.3 → 0.8.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4baddf5f52f2913d492f130ec8b45a08d37a6bb7
-  data.tar.gz: 5f96f9b1e90711b3ff6b54b191f3dae793d70793
+  metadata.gz: 115163af07e20e711b005878d50c95bf0bee0e44
+  data.tar.gz: dbc3c72f7a51d0c6b33ed2e4be6d1125584624dd
 SHA512:
-  metadata.gz: 286cf94f1999e471f05bf87ae34d60ca23609648eef332830873ea27b54d407cd68c01e8b552ab026880317ff684623c8a467df7338faef9233bcdc9f8b22d29
-  data.tar.gz: 853a3f70d00f98a04ac81cd0176e4a25f53db77536a451462c60ef7a9fc72d9ac5465806b916feadb5231efc29d138c2744bb9438814370586f7144e1c002d4a
+  metadata.gz: 63d576294781035dd5dc8b3f0623eb7942d76379fdd71a04665b0eace3516abfeb87b308ebd268ef8ae2a362991848db1b2328fc94ca6bad2b0616f40550a2ea
+  data.tar.gz: 84e49edf392da2bb5a161684102e205a103b1cf3822c0a8383228a47e2ce79aa9c496f076217f9ed2c017c3516eb4a2ba870e14119ccde113e0fc2fd08995efe

data/Rakefile

@@ -8,7 +8,7 @@ task :default => :specs
 
 desc "Builds the gem"
 task :gem do
-  Gem::Builder.new(eval(File.read('yard.gemspec'))).build
+  sh "gem build yard.gemspec"
 end
 
 desc "Installs the gem"

data/lib/yard.rb

@@ -33,7 +33,7 @@ module YARD
     return @windows if defined? @windows
     require 'rbconfig'
     if ::RbConfig::CONFIG['host_os'] =~ /mingw|win32|cygwin/
-      @wnidows = true
+      @windows = true
     else
       @windows = false
     end

data/lib/yard/autoload.rb

@@ -99,6 +99,7 @@ module YARD
         autoload :MixinHandler,           __p('handlers/ruby/legacy/mixin_handler')
         autoload :ModuleHandler,          __p('handlers/ruby/legacy/module_handler')
         autoload :ModuleFunctionHandler,  __p('handlers/ruby/legacy/module_function_handler')
+        autoload :PrivateClassMethodHandler, __p('handlers/ruby/legacy/private_class_method_handler')
         autoload :PrivateConstantHandler, __p('handlers/ruby/legacy/private_constant_handler')
         autoload :VisibilityHandler,      __p('handlers/ruby/legacy/visibility_handler')
         autoload :YieldHandler,           __p('handlers/ruby/legacy/yield_handler')
@@ -122,6 +123,7 @@ module YARD
       autoload :MixinHandler,             __p('handlers/ruby/mixin_handler')
       autoload :ModuleHandler,            __p('handlers/ruby/module_handler')
       autoload :ModuleFunctionHandler,    __p('handlers/ruby/module_function_handler')
+      autoload :PrivateClassMethodHandler, __p('handlers/ruby/private_class_method_handler')
       autoload :PrivateConstantHandler,   __p('handlers/ruby/private_constant_handler')
       autoload :StructHandlerMethods,     __p('handlers/ruby/struct_handler_methods')
       autoload :VisibilityHandler,        __p('handlers/ruby/visibility_handler')

data/lib/yard/cli/stats.rb

@@ -59,7 +59,10 @@ module YARD
           end
         end
         meths.each {|m| send(m) }
-        if @total == 0
+
+        if @undocumented == 0
+          total = 100
+        elsif @total == 0
           total = 0
         else
           total = (@total - @undocumented).to_f / @total.to_f * 100
@@ -125,8 +128,8 @@ module YARD
       # Statistics for methods
       def stats_for_methods
         objs = all_objects.select {|m| m.type == :method }
-        objs.reject! {|m| m.is_alias? || !m.is_explicit? }
-        undoc = objs.select {|m| m.docstring.blank? && !m.overridden_method }
+        objs.reject! {|m| m.is_alias? }
+        undoc = objs.select {|m| m.docstring.blank? }
         @undoc_list |= undoc if @undoc_list
         output "Methods", objs.size, undoc.size
       end

data/lib/yard/config.rb

@@ -123,8 +123,9 @@ module YARD
       add_ignored_plugins_file
       translate_plugin_names
       load_plugins
-    rescue
+    rescue => e
       log.error "Invalid configuration file, using default options."
+      log.backtrace(e)
       options.update(DEFAULT_CONFIG_OPTIONS)
     end
 

data/lib/yard/handlers/c/handler_methods.rb

@@ -8,6 +8,11 @@ module YARD
         def handle_class(var_name, class_name, parent, in_module = nil)
           parent = nil if parent == "0"
           namespace = in_module ? namespace_for_variable(in_module) : Registry.root
+          if namespace.nil?
+            raise Parser::UndocumentableError, "class #{class_name}. " +
+              "Cannot find definition for parent namespace."
+          end
+
           register ClassObject.new(namespace, class_name) do |obj|
             if parent
               parent_class = namespace_for_variable(parent)
@@ -25,6 +30,11 @@ module YARD
 
         def handle_module(var_name, module_name, in_module = nil)
           namespace = in_module ? namespace_for_variable(in_module) : Registry.root
+          if namespace.nil?
+            raise Parser::UndocumentableError, "module #{module_name}. " +
+              "Cannot find definition for parent namespace."
+          end
+
           register ModuleObject.new(namespace, module_name) do |obj|
             namespaces[var_name] = obj
             register_file_info(obj, statement.file, statement.line)
@@ -45,6 +55,7 @@ module YARD
           register MethodObject.new(namespace, name, scope) do |obj|
             register_visibility(obj, visibility)
             find_method_body(obj, func_name)
+            obj.explicit = true
             obj.add_tag(Tags::Tag.new(:return, '', 'Boolean')) if name =~ /\?$/
           end
         end

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

@@ -0,0 +1,21 @@
+# (see Ruby::PrivateClassMethodHandler)
+class YARD::Handlers::Ruby::Legacy::PrivateClassMethodHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles /\Aprivate_class_method(\s|\(|$)/
+  namespace_only
+
+  process do
+    tokval_list(statement.tokens[2..-1], :attr).each do |name|
+      privatize_class_method name
+    end
+  end
+
+  private
+
+  def privatize_class_method(name)
+    method = Proxy.new(namespace, name)
+    ensure_loaded!(method)
+    method.visibility = :private
+  rescue NamespaceMissingError
+    raise UndocumentableError, "private visibility set on unrecognized method: #{name}"
+  end
+end

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

@@ -0,0 +1,35 @@
+# Sets visibility of a class method
+class YARD::Handlers::Ruby::PrivateClassMethodHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:private_class_method)
+  namespace_only
+
+  process do
+    errors = []
+    statement.parameters.each do |param|
+      next unless AstNode === param
+      begin
+        privatize_class_method(param)
+      rescue UndocumentableError => err
+        errors << err.message
+      end
+    end
+    if errors.size > 0
+      msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
+      raise UndocumentableError, "private class_method#{msg} for #{namespace.path}"
+    end
+  end
+
+  private
+
+  def privatize_class_method(node)
+    if node.literal?
+      method = Proxy.new(namespace, node[0][0][0], :method)
+      ensure_loaded!(method)
+      method.visibility = :private
+    else
+      raise UndocumentableError, "invalid argument to private_class_method: #{node.source}"
+    end
+  rescue NamespaceMissingError
+    raise UndocumentableError, "private visibility set on unrecognized method: #{node[0]}"
+  end
+end

data/lib/yard/i18n/pot_generator.rb

@@ -134,7 +134,7 @@ module YARD
 
       private
       def header
-        <<-'EOH'
+        <<-EOH
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
@@ -143,20 +143,28 @@ module YARD
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2011-11-20 22:17+0900\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"Language: \n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
+"Project-Id-Version: PACKAGE VERSION\\n"
+"Report-Msgid-Bugs-To: \\n"
+"POT-Creation-Date: #{generate_pot_creation_date_value}\\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\\n"
+"Language-Team: LANGUAGE <LL@li.org>\\n"
+"Language: \\n"
+"MIME-Version: 1.0\\n"
+"Content-Type: text/plain; charset=UTF-8\\n"
+"Content-Transfer-Encoding: 8bit\\n"
 
 EOH
       end
 
+      def current_time
+        @current_time ||= Time.now
+      end
+
+      def generate_pot_creation_date_value
+        current_time.strftime("%Y-%m-%d %H:%M%z")
+      end
+
       def generate_message(pot, message)
         message.comments.sort.each do |comment|
           pot << "# #{comment}\n" unless comment.empty?

data/lib/yard/logging.rb

@@ -88,17 +88,15 @@ module YARD
       if defined?(::Encoding)
         icon = PROGRESS_INDICATORS[@progress_indicator] + " "
       end
-      print("\e[2K\e[?25l\e[1m#{icon}#{msg}\e[0m\r")
       @mutex.synchronize do
+        print("\e[2K\e[?25l\e[1m#{icon}#{msg}\e[0m\r")
         @progress_msg = msg
         @progress_indicator += 1
         @progress_indicator %= PROGRESS_INDICATORS.size
       end
       Thread.new do
         sleep(0.05)
-        @mutex.synchronize do
-          progress(msg + ".", nil) if @progress_msg == msg
-        end
+        progress(msg + ".", nil) if @progress_msg == msg
       end
     end
 

data/lib/yard/rake/yardoc_task.rb

@@ -60,7 +60,7 @@ module YARD
       # Defines the rake task
       # @return [void]
       def define
-        desc "Generate YARD Documentation"
+        desc "Generate YARD Documentation" unless ::Rake.application.last_comment
         task(name) do
           before.call if before.is_a?(Proc)
           yardoc = YARD::CLI::Yardoc.new

data/lib/yard/tags/default_factory.rb

@@ -138,6 +138,13 @@ module YARD
         last_seen = ''
         while i < text.length
           c = text[i, 1]
+
+          if (c == '"' || c == "'") && text[i..-1] =~ /#{c}.+?#{c}/
+            list.last << $&
+            i += $&.length
+            next
+          end
+
           if level > 0 && c == '#' && text[i+1..-1] =~ CodeObjects::METHODNAMEMATCH
             list.last << c + $&
             i += $&.length + 1

data/lib/yard/verifier.rb

@@ -118,6 +118,7 @@ module YARD
     # @return [void]
     def unmodify_nilclass
       NILCLASS_METHODS.each do |meth|
+        next unless nil.respond_to?(meth)
         NilClass.send(:remove_method, meth)
       end
     end

data/lib/yard/version.rb

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

data/spec/cli/server_spec.rb

@@ -59,8 +59,6 @@ describe YARD::CLI::Server do
 
     @cli.run(*args.flatten)
     assert_libraries @libraries, @cli.libraries
-
-    new_cli
   end
 
   def assert_libraries(expected_libs, actual_libs)
@@ -92,22 +90,22 @@ describe YARD::CLI::Server do
 
     it "should use .yardoc as the yardoc db if .yardopts doesn't specify an alternate path" do
       mock_file '/path/to/bar/.yardopts', '--protected'
-      @libraries[@name] = [Server::LibraryVersion.new(@name, nil, '/path/to/bar/.yardoc')]
-      @libraries.values[0][0].source_path = '/path/to/bar'
+      @libraries[@name] = [Server::LibraryVersion.new(@name, nil, File.expand_path('/path/to/bar/.yardoc'))]
+      @libraries.values[0][0].source_path = File.expand_path('/path/to/bar')
       run
     end
 
     it "should use the yardoc db location specified by .yardopts" do
       mock_file '/path/to/bar/.yardopts', '--db foo'
-      @libraries[@name] = [Server::LibraryVersion.new(@name, nil, '/path/to/bar/foo')]
-      @libraries.values[0][0].source_path = '/path/to/bar'
+      @libraries[@name] = [Server::LibraryVersion.new(@name, nil, File.expand_path('/path/to/bar/foo'))]
+      @libraries.values[0][0].source_path = File.expand_path('/path/to/bar')
       run
     end
 
     it "should parse .yardopts when the library list is odd" do
       mock_file '/path/to/bar/.yardopts', '--db foo'
-      @libraries['a'] = [Server::LibraryVersion.new('a', nil, '/path/to/bar/foo')]
-      @libraries.values[0][0].source_path = '/path/to/bar'
+      @libraries['a'] = [Server::LibraryVersion.new('a', nil, File.expand_path('/path/to/bar/foo'))]
+      @libraries.values[0][0].source_path = File.expand_path('/path/to/bar')
       run 'a'
     end
   end
@@ -118,8 +116,8 @@ describe YARD::CLI::Server do
     end
 
     it "should default to .yardoc if no library is specified" do
-      Dir.should_receive(:pwd).at_least(:once).and_return('/path/to/foo')
-      @libraries['foo'] = [Server::LibraryVersion.new('foo', nil, '/path/to/foo/.yardoc')]
+      Dir.should_receive(:pwd).at_least(:once).and_return(File.expand_path('/path/to/foo'))
+      @libraries['foo'] = [Server::LibraryVersion.new('foo', nil, File.expand_path('/path/to/foo/.yardoc'))]
       run
     end
 

data/spec/cli/stats_spec.rb

@@ -85,6 +85,6 @@ eof
       "Classes:         0 (    0 undocumented)\n" +
       "Constants:       0 (    0 undocumented)\n" +
       "Methods:         0 (    0 undocumented)\n" +
-      " 0.00% documented\n"
+      " 100.00% documented\n"
   end
 end

data/spec/handlers/c/module_handler_spec.rb

@@ -35,4 +35,24 @@ describe YARD::Handlers::C::ClassHandler do
     Registry.at('Foo').file.should == '(stdin)'
     Registry.at('Foo').line.should == 2
   end
+
+  it "should raise undoc error if a class is defined under a namespace that cannot be resolved" do
+    with_parser(:c) do
+      undoc_error <<-eof
+        void Init_Foo() {
+          mFoo = rb_define_class_under(invalid, "Foo", rb_cObject);
+        }
+      eof
+    end
+  end unless ENV['LEGACY']
+
+  it "should raise undoc error if a module is defined under a namespace that cannot be resolved" do
+    with_parser(:c) do
+      undoc_error <<-eof
+        void Init_Foo() {
+          mFoo = rb_define_module_under(invalid, "Foo");
+        }
+      eof
+    end
+  end unless ENV['LEGACY']
 end

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

@@ -0,0 +1,7 @@
+class A
+  def self.b; end
+  def self.c; end
+  def self.d; end
+
+  private_class_method(:c, :d)
+end

data/spec/handlers/private_class_method_handler_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PrivateClassMethodHandler" do
+  before(:all) { parse_file :private_class_method_handler_001, __FILE__ }
+
+  it "should handle private_class_method statement" do
+    Registry.at('A.c').visibility.should == :private
+    Registry.at('A.d').visibility.should == :private
+  end
+
+  it "should fail if parameter is not String or Symbol" do
+    undoc_error 'class Foo; private_class_method "x"; end'
+    undoc_error 'class Foo; X = 1; private_class_method X.new("hi"); end'
+  end unless LEGACY_PARSER
+
+  it "should fail if method can't be recognized" do
+    undoc_error 'class Foo2; private_class_method :x; end'
+  end
+end

data/spec/i18n/pot_generator_spec.rb

@@ -25,7 +25,10 @@ describe YARD::I18n::PotGenerator do
 
   describe "Generate" do
     it "should generate the default header" do
-      @generator.generate.should == <<-'eoh'
+      current_time = Time.parse("2011-11-20 22:17+0900")
+      @generator.stub!(:current_time).and_return(current_time)
+      pot_creation_date = current_time.strftime("%Y-%m-%d %H:%M%z")
+      @generator.generate.should == <<-eoh
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
@@ -34,16 +37,16 @@ describe YARD::I18n::PotGenerator do
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: PACKAGE VERSION\n"
-"Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2011-11-20 22:17+0900\n"
-"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
-"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
-"Language-Team: LANGUAGE <LL@li.org>\n"
-"Language: \n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
+"Project-Id-Version: PACKAGE VERSION\\n"
+"Report-Msgid-Bugs-To: \\n"
+"POT-Creation-Date: #{pot_creation_date}\\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\\n"
+"Language-Team: LANGUAGE <LL@li.org>\\n"
+"Language: \\n"
+"MIME-Version: 1.0\\n"
+"Content-Type: text/plain; charset=UTF-8\\n"
+"Content-Transfer-Encoding: 8bit\\n"
 
 eoh
     end

data/spec/server/doc_server_serializer_spec.rb

@@ -44,7 +44,11 @@ describe YARD::Server::DocServerSerializer do
 
     it "should handle unicode data" do
       file = CodeObjects::ExtraFileObject.new("test\u0160", '')
-      @serializer.serialized_path(file).should == 'file/test_C5A0'
+      if file.name.encoding == Encoding.find("Windows-1252")
+        @serializer.serialized_path(file).should == 'file/test_8A'
+      else
+        @serializer.serialized_path(file).should == 'file/test_C5A0'
+      end
     end if defined?(::Encoding)
   end
 end

data/spec/tags/default_factory_spec.rb

@@ -71,6 +71,11 @@ describe YARD::Tags::DefaultFactory do
       v = parse_types(' [Test, Array<String, Hash{A => {B => C}}, C>, String]')
       v.should include(["Test", "Array<String, Hash{A => {B => C}}, C>", "String"])
     end
+
+    it "should handle quoted values" do
+      v = parse_types(' ["foo, bar", \'baz, qux\', in"them,iddle"]')
+      v.should include(["\"foo, bar\"", "'baz, qux'", 'in"them,iddle"'])
+    end
   end
 
   describe '#parse_tag_with_types' do

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

@@ -291,6 +291,7 @@ li.r2 { background: #fafafa; }
   -moz-box-shadow: -2px 2px 6px #bbb;
   z-index: 5000;
   position: relative;
+  overflow-x: auto;
 }
 #toc.nofloat { float: none; max-width: none; border: none; padding: 0; margin: 20px 0; -webkit-box-shadow: none; -moz-box-shadow: none; }
 #toc.nofloat.hidden { padding: 0; background: 0; margin-bottom: 5px; }

data/templates/default/layout/html/script_setup.erb

@@ -1,5 +1,5 @@
 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '<%= u = url_for(''); u + (u != '' ? '/' : '') %>';
-  framesUrl = "<%= url_for_frameset %>#!" + escape(window.location.href);
+  framesUrl = "<%= url_for_frameset %>#!<%= url_for(@file || @object, nil, false) %>";
 </script>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.8.7.3
+  version: 0.8.7.4
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2014-03-22 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -131,6 +131,7 @@ files:
 - lib/yard/handlers/ruby/legacy/mixin_handler.rb
 - lib/yard/handlers/ruby/legacy/module_function_handler.rb
 - lib/yard/handlers/ruby/legacy/module_handler.rb
+- lib/yard/handlers/ruby/legacy/private_class_method_handler.rb
 - lib/yard/handlers/ruby/legacy/private_constant_handler.rb
 - lib/yard/handlers/ruby/legacy/visibility_handler.rb
 - lib/yard/handlers/ruby/legacy/yield_handler.rb
@@ -139,6 +140,7 @@ files:
 - lib/yard/handlers/ruby/mixin_handler.rb
 - lib/yard/handlers/ruby/module_function_handler.rb
 - lib/yard/handlers/ruby/module_handler.rb
+- lib/yard/handlers/ruby/private_class_method_handler.rb
 - lib/yard/handlers/ruby/private_constant_handler.rb
 - lib/yard/handlers/ruby/struct_handler_methods.rb
 - lib/yard/handlers/ruby/visibility_handler.rb
@@ -311,6 +313,7 @@ files:
 - spec/handlers/examples/method_handler_001.rb.txt
 - spec/handlers/examples/mixin_handler_001.rb.txt
 - spec/handlers/examples/module_handler_001.rb.txt
+- spec/handlers/examples/private_class_method_handler_001.rb.txt
 - spec/handlers/examples/private_constant_handler_001.rb.txt
 - spec/handlers/examples/process_handler_001.rb.txt
 - spec/handlers/examples/visibility_handler_001.rb.txt
@@ -323,6 +326,7 @@ files:
 - spec/handlers/mixin_handler_spec.rb
 - spec/handlers/module_function_handler_spec.rb
 - spec/handlers/module_handler_spec.rb
+- spec/handlers/private_class_method_handler_spec.rb
 - spec/handlers/private_constant_handler_spec.rb
 - spec/handlers/processor_spec.rb
 - spec/handlers/ruby/base_spec.rb