yard 0.8.7.4 → 0.8.7.5

data/spec/handlers/private_class_method_handler_spec.rb

@@ -4,16 +4,51 @@ describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PrivateClassMe
   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
+    Registry.at('A.c').visibility.should eq :private
+    Registry.at('A.d').visibility.should eq :private
+    Registry.at('A.e').visibility.should eq :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'
+    undoc_error 'class Foo; X = 1; private_class_method 123; 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
+  # Issue #760
+  # https://github.com/lsegal/yard/issues/760
+  it "should handle singleton classes" do
+    # Note: It's important to def a method within the singleton class or
+    #       the bug may not trigger.
+    code = 'class SingletonClass; private_class_method :new; def self.foo; "foo"end; end'
+    StubbedSourceParser.parse_string(code) # Should be successful.
+  end unless LEGACY_PARSER
+  
+  
+  describe "should handle reopened class" do
+    
+    # Modified #parse_file from '/spec/spec_helper.rb' because the second example
+    # file was overwriting the data from the first example when trying to reopen
+    # the class.
+    def parse_files(files, thisfile = __FILE__, log_level = log.level, ext = '.rb.txt')
+      Registry.clear
+      paths = files.map { |file| File.join(File.dirname(thisfile), 'examples', file.to_s + ext) }
+      YARD::Parser::SourceParser.parse(paths, [], log_level)
+    end
+    
+    before {
+      parse_files [
+        :private_class_method_handler_002,
+        :private_class_method_handler_003
+      ], __FILE__
+    }
+    
+    specify do
+      Registry.at('SingletonClass.foo').visibility.should eq :public
+      Registry.at('SingletonClass.bar').visibility.should eq :private
+      Registry.at('SingletonClass.baz').visibility.should eq :private
+      Registry.at('SingletonClass.bat').visibility.should eq :public
+    end
+    
+  end unless LEGACY_PARSER # reopened class
+   
 end

data/spec/i18n/pot_generator_spec.rb

@@ -205,6 +205,36 @@ eod
         }
       })
     end
+
+    it "should extract overload tag recursively" do
+      object = YARD::CodeObjects::MethodObject.new(@yard, :parse, :module) do |o|
+        o.docstring = <<-eod
+@overload foo(i)
+  docstring foo(i)
+  @param [Integer] i integer parameter
+eod
+      end
+
+      @generator.parse_objects([object])
+      @generator.messages.should == create_messages({
+        "tag|overload|foo" => {
+          :locations => [],
+          :comments => ["@overload"]
+        },
+        "docstring foo(i)" => {
+          :locations => [],
+          :comments => ["YARD.parse"]
+        },
+        "tag|param|i" => {
+          :locations => [],
+          :comments => ["@param [Integer]"]
+        },
+        "integer parameter" => {
+          :locations => [],
+          :comments => ["@param [Integer] i"]
+        },
+      })
+    end
   end
 
   describe "File" do

data/spec/parser/c_parser_spec.rb

@@ -126,6 +126,24 @@ describe YARD::Parser::C::CParser do
         end
       end
     end
+
+    describe 'C macros in declaration' do
+      it "should handle C macros in method declaration" do
+        Registry.clear
+        parse <<-eof
+        // docstring
+        FOOBAR VALUE func() { }
+
+        void
+        Init_mod(void)
+        {
+          rb_define_method(rb_cFoo, "func", func, 0); \
+        }
+        eof
+
+        Registry.at('Foo#func').docstring.should == "docstring"
+      end
+    end
   end
 
   describe 'Override comments' do

data/spec/parser/ruby/ruby_parser_spec.rb

@@ -178,11 +178,40 @@ eof
       ast.jump(:class).line_range.should == (2..4)
     end
 
+    it 'should handle defs with unnamed argument with default values' do
+      ast = stmt('def hello(one, two = 2, three = 3) end').jump(:params)
+      ast.source.should == 'one, two = 2, three = 3'
+    end
+
+    it 'should handle defs with splats' do
+      ast = stmt('def hello(one, *two) end').jump(:params)
+      ast.source.should == 'one, *two'
+    end
+
+    if YARD.ruby2?
+      it 'should handle defs with named arguments with default values' do
+        ast = stmt('def hello(one, two: 2, three: 3) end').jump(:params)
+        ast.source.should == 'one, two: 2, three: 3'
+      end
+    end
+
+    if NAMED_OPTIONAL_ARGUMENTS
+      it 'should handle defs with named arguments without default values' do
+        ast = stmt('def hello(one, two:, three:) end').jump(:params)
+        ast.source.should == 'one, two:, three:'
+      end
+
+      it 'should handle defs with double splats' do
+        ast = stmt('def hello(one, **two) end').jump(:params)
+        ast.source.should == 'one, **two'
+      end
+    end
+
     it "should end source properly on array reference" do
       ast = stmt("AS[0, 1 ]   ")
       ast.source.should == 'AS[0, 1 ]'
 
-      ast = stmt("def x(a = S[1]) end").jump(:default_arg)
+      ast = stmt('def x(a = S[1]) end').jump(:params)
       ast.source.should == 'a = S[1]'
     end
 
@@ -330,5 +359,17 @@ eof
       ast.first.last.last.type.should == :comment
       ast.first.last.last.docstring.should == "end comment"
     end
+
+    it "should not group comments if they don't begin the line" do
+      Registry.clear
+      ast = YARD.parse_string(<<-eof).enumerator
+        class Foo
+          CONST1 = 1 # Comment here
+          CONST2 = 2 # Another comment here
+        end
+      eof
+      Registry.at("Foo::CONST1").docstring.should == "Comment here"
+      Registry.at("Foo::CONST2").docstring.should == "Another comment here"
+    end
   end
 end if HAVE_RIPPER

data/spec/parser/source_parser_spec.rb

@@ -708,10 +708,20 @@ describe YARD::Parser::SourceParser do
       Registry.at('A::B#d').should_not be_nil
     end
 
-    it 'supports keyword arguments' do
-      YARD.parse_string 'def foo(a: 1, b: 2, **kwargs) end'
-      args = [['a:', '1'], ['b:', '2'], ['**kwargs', nil]]
-      Registry.at('#foo').parameters.should eq(args)
-    end if YARD.ruby2?
+    if YARD.ruby2?
+      it 'supports named arguments with default values' do
+        YARD.parse_string 'def foo(a, b = 1, *c, d, e: 3, **f, &g) end'
+        args = [['a', nil], ['b', '1'], ['*c', nil], ['d', nil], ['e:', '3'], ['**f', nil], ['&g', nil]]
+        Registry.at('#foo').parameters.should eq(args)
+      end
+    end
+
+    if NAMED_OPTIONAL_ARGUMENTS && !LEGACY_PARSER
+      it 'supports named arguments without default values' do
+        YARD.parse_string 'def foo(a, b = 1, *c, d, e: 3, f:, **g, &h) end'
+        args = [['a', nil], ['b', '1'], ['*c', nil], ['d', nil], ['e:', '3'], ['f:', nil], ['**g', nil], ['&h', nil]]
+        Registry.at('#foo').parameters.should eq(args)
+      end
+    end
   end
 end

data/spec/rake/yardoc_task_spec.rb

@@ -56,6 +56,33 @@ describe YARD::Rake::YardocTask do
     end
   end
 
+  describe '#stats_options' do
+    before do
+      @yard_stats = Object.new
+      @yard_stats.stub!(:run)
+      YARD::CLI::Stats.stub!(:new).and_return(@yard_stats)
+    end
+
+    it "should not invoke stats" do
+      @yard_stats.should_not_receive(:run)
+      @yardoc.statistics = true
+      YARD::Rake::YardocTask.new do |t|
+      end
+      run
+      @yardoc.statistics.should == true
+    end
+
+    it "should invoke stats" do
+      @yard_stats.should_receive(:run).with('--list-undoc', '--use-cache')
+      @yardoc.statistics = true
+      YARD::Rake::YardocTask.new do |t|
+        t.stats_options = %w(--list-undoc)
+      end
+      run
+      @yardoc.statistics.should == false
+    end
+  end
+
   describe '#before' do
     it "should allow before callback" do
       proc = lambda { }

data/spec/spec_helper.rb

@@ -36,6 +36,8 @@ unless defined?(HAVE_RIPPER)
   end if ENV['LEGACY']
 end
 
+NAMED_OPTIONAL_ARGUMENTS = RUBY_VERSION >= '2.1.0'
+
 def parse_file(file, thisfile = __FILE__, log_level = log.level, ext = '.rb.txt')
   Registry.clear
   path = File.join(File.dirname(thisfile), 'examples', file.to_s + ext)

data/spec/templates/helpers/html_helper_spec.rb

@@ -166,6 +166,38 @@ describe YARD::Templates::Helpers::HtmlHelper do
       htmlify('{http://example.com}', :markdown).chomp.should =~
         %r{<p><a href="http://example.com".*>http://example.com</a></p>}
     end
+
+    it "should create tables (markdown specific)" do
+      log.enter_level(Logger::FATAL) do
+        unless markup_class(:markdown).to_s == "RedcarpetCompat"
+          pending 'This test depends on a markdown engine that supports tables'
+        end
+      end
+
+      markdown = <<-EOF.strip
+        City    | State | Country
+        --------|-------|--------
+        Raleigh | NC    | US
+        Seattle | WA    | US
+      EOF
+
+      html = htmlify(markdown, :markdown)
+      html.should =~ %r{<table>}
+      html.should =~ %r{<th>City</th>}
+      html.should =~ %r{<td>NC</td>}
+    end
+
+    it 'should handle fenced code blocks (Redcarpet specific)' do
+      log.enter_level(Logger::FATAL) do
+        unless markup_class(:markdown).to_s == 'RedcarpetCompat'
+          pending 'This test is Redcarpet specific'
+        end
+      end
+
+      markdown = "Introduction:\n```ruby\nputs\n\nputs\n```"
+      html = htmlify(markdown, :markdown)
+      html.should =~ %r{^<p>Introduction:</p>.*<code class="ruby">}m
+    end
   end
 
   describe "#link_object" do

data/templates/default/fulldoc/html/full_list.erb

@@ -16,7 +16,11 @@
   </head>
   <body>
     <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) {
+      var hasFrames = false;
+      try {
+        hasFrames = window.top.frames.main ? true : false;
+      } catch (e) { }
+      if (hasFrames) {
         document.getElementById('base_target').target = 'main';
         document.body.className = 'frames';
       }

data/templates/default/fulldoc/html/js/full_list.js

@@ -123,7 +123,10 @@ function linkList() {
       }
     }
     if (clicked) clicked.removeClass('clicked');
-    var win = window.top.frames.main ? window.top.frames.main : window.parent;
+    var win;
+    try {
+      win = window.top.frames.main ? window.top.frames.main : window.parent;
+    } catch (e) { win = window.parent; }
     if (this.tagName.toLowerCase() == "a") {
       clicked = $(this).parents('li').addClass('clicked');
       win.location = this.href;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.8.7.4
+  version: 0.8.7.5
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-22 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -23,18 +23,45 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- LEGAL
+- LICENSE
+- README.md
+- Rakefile
+- benchmarks/builtins_vs_eval.rb
+- benchmarks/concat_vs_join.rb
+- benchmarks/erb_vs_erubis.rb
+- benchmarks/format_args.rb
+- benchmarks/generation.rb
+- benchmarks/marshal_vs_dbm.rb
+- benchmarks/parsing.rb
+- benchmarks/pathname_vs_string.rb
+- benchmarks/rdoc_vs_yardoc.rb
+- benchmarks/registry_store_types.rb
+- benchmarks/ri_vs_yri.rb
+- benchmarks/ripper_parser.rb
+- benchmarks/splat_vs_flatten.rb
+- benchmarks/template_erb.rb
+- benchmarks/template_format.rb
+- benchmarks/template_profile.rb
+- benchmarks/yri_cache.rb
+- bin/yard
+- bin/yardoc
+- bin/yri
 - docs/CodeObjects.md
 - docs/GettingStarted.md
 - docs/Handlers.md
+- docs/Overview.md
+- docs/Parser.md
+- docs/Tags.md
+- docs/TagsArch.md
+- docs/Templates.md
+- docs/WhatsNew.md
 - docs/images/code-objects-class-diagram.png
 - docs/images/handlers-class-diagram.png
 - docs/images/overview-class-diagram.png
 - docs/images/parser-class-diagram.png
 - docs/images/tags-class-diagram.png
-- docs/Overview.md
-- docs/Parser.md
-- docs/Tags.md
-- docs/TagsArch.md
 - docs/templates/default/fulldoc/html/full_list_tag.erb
 - docs/templates/default/fulldoc/html/setup.rb
 - docs/templates/default/layout/html/setup.rb
@@ -42,12 +69,8 @@ files:
 - docs/templates/default/yard_tags/html/list.erb
 - docs/templates/default/yard_tags/html/setup.rb
 - docs/templates/plugin.rb
-- docs/Templates.md
-- docs/WhatsNew.md
-- bin/yard
-- bin/yardoc
-- bin/yri
 - lib/rubygems_plugin.rb
+- lib/yard.rb
 - lib/yard/autoload.rb
 - lib/yard/cli/command.rb
 - lib/yard/cli/command_parser.rb
@@ -168,11 +191,11 @@ files:
 - lib/yard/rake/yardoc_task.rb
 - lib/yard/registry.rb
 - lib/yard/registry_store.rb
-- lib/yard/rubygems/backports/gem.rb
+- lib/yard/rubygems/backports.rb
 - lib/yard/rubygems/backports/LICENSE.txt
 - lib/yard/rubygems/backports/MIT.txt
+- lib/yard/rubygems/backports/gem.rb
 - lib/yard/rubygems/backports/source_index.rb
-- lib/yard/rubygems/backports.rb
 - lib/yard/rubygems/doc_manager.rb
 - lib/yard/rubygems/specification.rb
 - lib/yard/serializers/base.rb
@@ -180,6 +203,7 @@ files:
 - lib/yard/serializers/process_serializer.rb
 - lib/yard/serializers/stdout_serializer.rb
 - lib/yard/serializers/yardoc_serializer.rb
+- lib/yard/server.rb
 - lib/yard/server/adapter.rb
 - lib/yard/server/commands/base.rb
 - lib/yard/server/commands/display_file_command.rb
@@ -214,7 +238,6 @@ files:
 - lib/yard/server/templates/doc_server/search/html/search.erb
 - lib/yard/server/templates/doc_server/search/html/setup.rb
 - lib/yard/server/webrick_adapter.rb
-- lib/yard/server.rb
 - lib/yard/tags/default_factory.rb
 - lib/yard/tags/default_tag.rb
 - lib/yard/tags/directives.rb
@@ -243,7 +266,6 @@ files:
 - lib/yard/templates/template_options.rb
 - lib/yard/verifier.rb
 - lib/yard/version.rb
-- lib/yard.rb
 - spec/cli/command_parser_spec.rb
 - spec/cli/command_spec.rb
 - spec/cli/config_spec.rb
@@ -314,6 +336,8 @@ files:
 - 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_class_method_handler_002.rb.txt
+- spec/handlers/examples/private_class_method_handler_003.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
@@ -362,9 +386,9 @@ files:
 - spec/registry_store_spec.rb
 - spec/rubygems/doc_manager_spec.rb
 - spec/serializers/data/serialized_yardoc/checksums
+- spec/serializers/data/serialized_yardoc/objects/Foo.dat
 - spec/serializers/data/serialized_yardoc/objects/Foo/bar_i.dat
 - spec/serializers/data/serialized_yardoc/objects/Foo/baz_i.dat
-- spec/serializers/data/serialized_yardoc/objects/Foo.dat
 - spec/serializers/data/serialized_yardoc/objects/root.dat
 - spec/serializers/data/serialized_yardoc/proxy_types
 - spec/serializers/file_system_serializer_spec.rb
@@ -558,28 +582,6 @@ files:
 - templates/guide/onefile/html/setup.rb
 - templates/guide/onefile/html/toc.erb
 - templates/guide/tags/html/setup.rb
-- benchmarks/builtins_vs_eval.rb
-- benchmarks/concat_vs_join.rb
-- benchmarks/erb_vs_erubis.rb
-- benchmarks/format_args.rb
-- benchmarks/generation.rb
-- benchmarks/marshal_vs_dbm.rb
-- benchmarks/parsing.rb
-- benchmarks/pathname_vs_string.rb
-- benchmarks/rdoc_vs_yardoc.rb
-- benchmarks/registry_store_types.rb
-- benchmarks/ri_vs_yri.rb
-- benchmarks/ripper_parser.rb
-- benchmarks/splat_vs_flatten.rb
-- benchmarks/template_erb.rb
-- benchmarks/template_format.rb
-- benchmarks/template_profile.rb
-- benchmarks/yri_cache.rb
-- LICENSE
-- LEGAL
-- README.md
-- Rakefile
-- .yardopts
 - yard.gemspec
 homepage: http://yardoc.org
 licenses:
@@ -591,19 +593,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: yard
-rubygems_version: 2.0.3
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Documentation tool for consistent and usable documentation in Ruby.
 test_files: []
-has_rdoc: yard