yard 0.9.16 → 0.9.19

data/spec/handlers/c/method_handler_spec.rb

@@ -213,6 +213,7 @@ RSpec.describe YARD::Handlers::C::MethodHandler do
     foo = Registry.at('Foo#foo?')
     expect(foo.docstring).to eq 'DOCSTRING'
     expect(foo.tag(:return).types).to eq ['Boolean']
+    expect(foo.tags(:return).size).to eq 1
   end
 
   it "does not add return tag if return tags exist" do
@@ -226,6 +227,7 @@ RSpec.describe YARD::Handlers::C::MethodHandler do
     eof
     foo = Registry.at('Foo#foo?')
     expect(foo.tag(:return).types).to eq ['String']
+    expect(foo.tags(:return).size).to eq 1
   end
 
   it "handles casted method names" do

data/spec/parser/c_parser_spec.rb

@@ -178,6 +178,19 @@ RSpec.describe YARD::Parser::C::CParser do
         expect(Registry.at('Foo#func').docstring).to eq "docstring"
       end
     end
+
+    describe "File singleton methods" do
+      before(:all) do
+        file = File.join(File.dirname(__FILE__), 'examples', 'file.c.txt')
+        parse(File.read(file))
+      end
+
+      it "parses methods from define_filetest_function" do
+        obj = YARD::Registry.at('File.exist?')
+        expect(obj).not_to be nil
+        expect(obj.docstring).not_to be_blank
+      end
+    end
   end
 
   describe "Override comments" do

data/spec/parser/examples/file.c.txt

@@ -0,0 +1,28 @@
+VALUE rb_cFile;
+
+/*
+ * call-seq:
+ *    File.exist?(file_name)    ->  true or false
+ *
+ * Return <code>true</code> if the named file exists.
+ *
+ * _file_name_ can be an IO object.
+ *
+ * "file exists" means that stat() or fstat() system call is successful.
+ */
+
+static VALUE
+rb_file_exist_p(VALUE obj, VALUE fname)
+{
+    struct stat st;
+
+    if (rb_stat(fname, &st) < 0) return Qfalse;
+    return Qtrue;
+}
+
+void
+Init_File(void)
+{
+	rb_cFile = rb_define_class("File", rb_cIO);
+    define_filetest_function("exist?", rb_file_exist_p, 1);
+}

data/spec/templates/helpers/html_helper_spec.rb

@@ -214,6 +214,40 @@ RSpec.describe YARD::Templates::Helpers::HtmlHelper do
       html = htmlify(markdown, :markdown)
       expect(html).to match %r{^<p>Introduction:</p>.*<code class="ruby">}m
     end
+
+    it "sets env and env-yard attributes (AsciiDoc specific)" do
+      adoc = <<-EOF.strip.gsub(/^ +/, "") # strip and unindent
+        ifdef::env[]
+        Attribute "env" is set, and its value is "{env}".
+        endif::[]
+
+        ifdef::env-yard[]
+        Attribute "env-yard" is set, and its value is "{env-yard}".
+        endif::[]
+      EOF
+      html = htmlify(adoc, :asciidoc)
+      expect(html).to match(/"env" is set, and its value is "yard"./)
+      expect(html).to match(/"env-yard" is set, and its value is ""./)
+    end
+
+    it "should not include the document title from the AsciiDoc header" do
+      adoc = <<-EOF.strip.gsub(/^ +/, "") # strip and unindent
+        = Project Name
+
+        Introduction.
+
+        == Installation
+
+        Installation instructions.
+
+        == Usage
+
+        Usage instructions.
+      EOF
+      html = htmlify(adoc, :asciidoc)
+      expect(html).to_not match(/Project Name/)
+      expect(html).to include(%(<h2 id="_installation">Installation</h2>))
+    end
   end
 
   describe "#link_object" do

data/spec/templates/method_spec.rb

@@ -101,7 +101,7 @@ RSpec.describe YARD::Templates::Engine.template(:default, :method) do
     it_should_behave_like "all formats"
   end
 
-  describe "method with keyword arguments spalt" do
+  describe "method with keyword arguments" do
     before do
       @template = :method006
       YARD.parse_string <<-'eof'
@@ -114,5 +114,5 @@ RSpec.describe YARD::Templates::Engine.template(:default, :method) do
     end
 
     it_should_behave_like "all formats"
-  end
+  end if RUBY_VERSION >= "2.1"
 end

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

@@ -275,6 +275,16 @@ function mainFocus() {
   setTimeout(function() { $('#main').focus(); }, 10);
 }
 
+function navigationChange() {
+  // This works around the broken anchor navigation with the YARD template.
+  window.onpopstate = function() {
+    var hash = window.location.hash;
+    if (hash !== '' && $(hash)[0]) {
+      $(hash)[0].scrollIntoView();
+    }
+  };
+}
+
 $(document).ready(function() {
   navResizer();
   navExpander();
@@ -287,6 +297,7 @@ $(document).ready(function() {
   constantSummaryToggle();
   generateTOC();
   mainFocus();
+  navigationChange();
 });
 
 })();

data/templates/default/onefile/html/setup.rb

@@ -41,7 +41,7 @@ def parse_top_comments_from_file
   tokens = TokenList.new(@readme.contents)
   tokens.each do |token|
     break unless token.is_a?(RubyToken::TkCOMMENT) || token.is_a?(RubyToken::TkNL)
-    data << (token.text[/\A#\s{0,1}(.*)/, 1] || "\n")
+    data += (token.text[/\A#\s{0,1}(.*)/, 1] || "\n")
   end
   YARD::Docstring.new(data)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.16
+  version: 0.9.19
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-11 00:00:00.000000000 Z
+date: 2019-04-02 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -129,6 +129,7 @@ files:
 - lib/yard/handlers/c/path_handler.rb
 - lib/yard/handlers/c/struct_handler.rb
 - lib/yard/handlers/c/symbol_handler.rb
+- lib/yard/handlers/common/method_handler.rb
 - lib/yard/handlers/processor.rb
 - lib/yard/handlers/ruby/alias_handler.rb
 - lib/yard/handlers/ruby/attribute_handler.rb
@@ -383,6 +384,7 @@ files:
 - spec/parser/examples/array.c.txt
 - spec/parser/examples/example1.rb.txt
 - spec/parser/examples/extrafile.c.txt
+- spec/parser/examples/file.c.txt
 - spec/parser/examples/multifile.c.txt
 - spec/parser/examples/namespace.cpp.txt
 - spec/parser/examples/override.c.txt
@@ -638,8 +640,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Documentation tool for consistent and usable documentation in Ruby.