yard 0.8.6.2 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79ac2562993c76c250d449d1c1b0e2a62b41790f
-  data.tar.gz: bb2c0b58aac5e48b9c687e9495dbe5a420433259
+  metadata.gz: d5a75a0de55c021ca90c4b39745a2eaadf856a42
+  data.tar.gz: 097ff460e4d225578721e043e22ea8fe3591fc2f
 SHA512:
-  metadata.gz: a404522e86cef2f801bef43ab15d49af955968afcad5d31784c61e30089ba3a50e904cebf99aa2465109043544fdf4b04010e6ba901eca1c46220e730f2a882c
-  data.tar.gz: 0be733bd7b4c1599710cbffc77af09ff879a0a823774eab1ec5d94923b0f7b185f68ae0ffef42b5eaa180149516586e29797b1d4d3d0c084532c755ef717a117
+  metadata.gz: 625943ad3908f4ba36764219b7c4ea50ae48ea29fa3bc7779a277871f809013d491157d682f1818a9f7b4d255ed0a4ef2146aaca7eaa1af2e168fac3b60160af
+  data.tar.gz: ba9d09f74bcdd0042af46807c78b3b702248bd57d507c6e14c3db4c8336328178b2ed383469bb1fef0e8ec3616250ea5319a86219c7a9b67acbdcf73817d83e7

data/README.md

@@ -1,14 +1,14 @@
 # YARD: Yay! A Ruby Documentation Tool
 
-**Homepage**:     [http://yardoc.org](http://yardoc.org)   
+**Homepage**:     http://yardoc.org   
 **IRC**:          [irc.freenode.net / #yard](irc://irc.freenode.net/yard)    
-**Git**:          [http://github.com/lsegal/yard](http://github.com/lsegal/yard)   
+**Git**:          http://github.com/lsegal/yard   
 **Author**:       Loren Segal  
-**Contributors**: See Contributors section below    
+**Contributors**: http://github.com/lsegal/yard/contributors    
 **Copyright**:    2007-2013    
 **License**:      MIT License    
-**Latest Version**: 0.8.6.2    
-**Release Date**: June 27th 2013    
+**Latest Version**: 0.8.7    
+**Release Date**: July 26th 2013    
 
 ## Synopsis
 
@@ -283,6 +283,12 @@ More options can be seen by typing `yard graph --help`, but here is an example:
 
 ## Changelog
 
+- **July.26.13**: 0.8.7 release
+    - Added `--hide-api API` option to hide objects with a given `@api` tag (#685).
+    - Added "Returns ...." prefix to summary when a lone @return tag is used.
+    - Fixed issue that caused ref tags to be added to a docstring twice (#678).
+    - Fixed formatting issue in docstring summaries (#686)
+
 - **June.27.13**: 0.8.6.2 release
     - Fixed issue where `yard graph` was not displaying methods
 
@@ -589,13 +595,6 @@ More options can be seen by typing `yard graph --help`, but here is an example:
   power of YARD and what to expect from the syntax (Yardoc style meta tags).
 
 
-## Contributors
-
-Special thanks to all contributors for submitting patches. A full list of
-contributors including their patches can be found at:
-
-http://github.com/lsegal/yard/contributors
-
 ## Copyright
 
 YARD © 2007-2013 by [Loren Segal](mailto:lsegal@soen.ca). YARD is

data/lib/yard/cli/yardoc.rb

@@ -175,6 +175,11 @@ module YARD
       # @since 0.8.1
       attr_accessor :apis
 
+      # Keep track of which APIs are to be hidden
+      # @return [Array<String>] a list of APIs to be hidden
+      # @since 0.8.7
+      attr_accessor :hidden_apis
+
       # @return [Array<Symbol>] a list of tags to hide from templates
       # @since 0.6.0
       attr_accessor :hidden_tags
@@ -198,6 +203,7 @@ module YARD
         @options.reset_defaults
         @visibilities = [:public]
         @apis = []
+        @hidden_apis = []
         @assets = {}
         @excluded = []
         @files = []
@@ -430,11 +436,22 @@ module YARD
       # @return [void]
       # @since 0.8.1
       def add_api_verifier
-        return if apis.empty?
         no_api = true if apis.delete('')
-        expr = "#{apis.uniq.inspect}.include?(@api.text)"
-        expr += " || !@api" if no_api
-        options.verifier.add_expressions(expr)
+        exprs = []
+
+        if apis.size > 0
+          exprs << "#{apis.uniq.inspect}.include?(@api.text)"
+        end
+
+        if hidden_apis.size > 0
+          exprs << "!#{hidden_apis.uniq.inspect}.include?(@api.text)"
+        end
+
+        exprs = exprs.size > 0 ? [exprs.join(' && ')] : []
+        exprs << "!@api" if no_api
+
+        expr = exprs.join(' || ')
+        options.verifier.add_expressions(expr) unless expr.empty?
       end
 
       # Applies the specified locale to collected objects
@@ -566,6 +583,10 @@ module YARD
           apis.push(api)
         end
 
+        opts.on('--hide-api API', 'Hides given @api tag from documentation') do |api|
+          hidden_apis.push(api)
+        end
+
         opts.on('--embed-mixins', "Embeds mixin methods into class documentation") do
           options.embed_mixins << '*'
         end

data/lib/yard/docstring.rb

@@ -171,7 +171,7 @@ module YARD
     def summary
       resolve_reference
       return @summary if @summary
-      stripped = self.gsub(/<.+?>/m, '').strip
+      stripped = self.gsub(/<.+?>/m, '').gsub(/[\r\n](?![\r\n])/, ' ').strip
       open_parens = ['{', '(', '[']
       close_parens = ['}', ')', ']']
       num_parens = 0
@@ -328,9 +328,7 @@ module YARD
         return if CodeObjects::Proxy === @unresolved_reference
 
         reference, @unresolved_reference = @unresolved_reference, nil
-        resolved_tags = reference.docstring.tags
         self.all = [reference.docstring.all, @all].join("\n")
-        add_tag(*resolved_tags)
       end
     end
 

data/lib/yard/tags/directives.rb

@@ -388,7 +388,9 @@ module YARD
         handler = parser.handler
         object = parser.object
         self.parser = parser.class.new(parser.library)
+        parser.state.inside_directive = true
         parser.parse(tag.text, object, handler)
+        parser.state.inside_directive = false
       end
 
       def create_object
@@ -585,6 +587,8 @@ module YARD
         if %w(public protected private).include?(tag.text)
           if object.is_a?(CodeObjects::Base)
             object.visibility = tag.text.to_sym
+          elsif handler && !parser.state.inside_directive
+            handler.visibility = tag.text.to_sym
           else
             parser.state.visibility = tag.text.to_sym
           end

data/lib/yard/tags/overload_tag.rb

@@ -16,6 +16,7 @@ module YARD
       def object=(value)
         super(value)
         docstring.object = value
+        docstring.tags.each {|tag| tag.object = value }
       end
 
       def name(prefix = false)

data/lib/yard/version.rb

@@ -1,3 +1,3 @@
 module YARD
-  VERSION = "0.8.6.2"
+  VERSION = "0.8.7"
 end

data/spec/cli/yardoc_spec.rb

@@ -400,6 +400,33 @@ describe YARD::CLI::Yardoc do
     end
   end
 
+  describe '--hide-api option' do
+    it "should allow --hide-api to hide objects with api tags" do
+      YARD.parse_string <<-eof
+        # @api private
+        class Foo; end
+        class Bar; end
+        class Baz; end
+      eof
+      @yardoc.run('--hide-api', 'private')
+      @yardoc.options.verifier.run(Registry.all).
+        sort_by {|o| o.path }.should == [P('Bar'), P('Baz')]
+    end
+
+    it "should allow --hide-api to work with --api" do
+      YARD.parse_string <<-eof
+        # @api private
+        class Foo; end
+        # @api public
+        class Bar; end
+        class Baz; end
+      eof
+      @yardoc.run('--api', 'public', '--hide-api', 'private')
+      @yardoc.options.verifier.run(Registry.all).
+        sort_by {|o| o.path }.should == [P('Bar')]
+    end
+  end
+
   describe '--no-private option' do
     it "should accept --no-private" do
       obj = mock(:object)

data/spec/docstring_spec.rb

@@ -57,6 +57,11 @@ describe YARD::Docstring do
       doc.summary.should == 'Hello world.'
     end
 
+    it "should strip newlines in first paragraph before summarizing" do
+      doc = Docstring.new("Foo\n<code>==</code> bar.")
+      doc.summary.should == 'Foo == bar.'
+    end
+
     it "should return the first sentence" do
       o = Docstring.new("DOCSTRING. Another sentence")
       o.summary.should == "DOCSTRING."
@@ -313,12 +318,17 @@ describe YARD::Docstring do
       YARD.parse_string <<-eof
         class A
           # Docstring
+          # @return [Boolean]
           def a; end
           # (see #a)
           def b; end
         end
       eof
-      YARD::Registry.at('A#b').docstring.should == 'Docstring'
+
+      object = YARD::Registry.at('A#b')
+      object.docstring.should == 'Docstring'
+      object.tags.map {|x| x.tag_name }.should == ['return']
+
       YARD::Registry.clear
     end
   end

data/spec/tags/directives_spec.rb

@@ -432,5 +432,22 @@ describe YARD::Tags::VisibilityDirective do
         @parser.state.visibility.should be_nil
       end
     end
+
+    it "updates visibility on future methods" do
+      Registry.clear
+      YARD.parse_string <<-eof
+        class Foo
+          # @!visibility private
+
+
+          def foo; end
+          def bar; end
+          def baz; end
+        end
+      eof
+      %w(foo bar baz).each do |name|
+        Registry.at("Foo##{name}").visibility.should == :private
+      end
+    end if YARD::Parser::SourceParser.parser_type == :ruby
   end
 end

data/spec/templates/examples/module001.html

@@ -35,6 +35,7 @@
 </div>
 <div class="tags">
 
+
 </div><h2>Defined Under Namespace</h2>
 <p class="children">
 
@@ -62,9 +63,10 @@ and newlines.
 </div>
 <div class="tags">
 
+
 </div>
         </dt>
-        <dd><pre class="code">'value'</pre></dd>
+        <dd><pre class="code">&#39;value&#39;</pre></dd>
 
         <dt id="cvar-classvariable" class="deprecated">@@cvar =
           <div class="docstring">
@@ -76,9 +78,10 @@ and newlines.
 </div>
 <div class="tags">
 
+
 </div>
         </dt>
-        <dd><pre class="code">'value'</pre></dd>
+        <dd><pre class="code">&#39;value&#39;</pre></dd>
 
     </dl>
 
@@ -86,12 +89,6 @@ and newlines.
 
 
 
-
-
-
-
-
-
   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
   <ul class="summary">
 
@@ -114,6 +111,7 @@ and newlines.
 
 
 
+
     <span class="summary_desc"><div class='inline'>Returns the value of attribute attr1.</div></span>
 
 </li>
@@ -129,7 +127,10 @@ and newlines.
   </span>
 
 
-    <span class="note title readonly">readonly</span>
+
+
+      <span class="note title readonly">readonly</span>
+
 
 
 
@@ -162,6 +163,7 @@ and newlines.
 
 
 
+
     <span class="summary_desc"><div class='inline'></div></span>
 
 </li>
@@ -178,26 +180,23 @@ and newlines.
 
 
 
-    <span class="note title writeonly">writeonly</span>
 
 
+      <span class="note title writeonly">writeonly</span>
 
 
 
 
 
-    <span class="summary_desc"><div class='inline'>Sets the attribute attr4.</div></span>
-
-</li>
-
-
-  </ul>
 
 
 
+    <span class="summary_desc"><div class='inline'>Sets the attribute attr4.</div></span>
 
+</li>
 
 
+  </ul>
 
 
 
@@ -231,6 +230,7 @@ and newlines.
 
 
 
+
     <span class="summary_desc"><div class='inline'></div></span>
 
 </li>
@@ -263,6 +263,7 @@ and newlines.
 
 
 
+
     <span class="summary_desc"><div class='inline'></div></span>
 
 </li>
@@ -284,6 +285,7 @@ and newlines.
 
 
 
+
     <span class="summary_desc"><div class='inline'></div></span>
 
 </li>
@@ -305,6 +307,7 @@ and newlines.
 
 
 
+
     <span class="summary_desc"><div class='inline'>hello2.</div></span>
 
 </li>
@@ -326,6 +329,7 @@ and newlines.
 
 
 
+
     <span class="summary_desc"><div class='inline'></div></span>
 
 </li>
@@ -342,6 +346,7 @@ and newlines.
 
 
 
+
   <h3 class="inherited">Methods included from B</h3>
   <p class="inherited">#c, #d</p>
 
@@ -350,6 +355,7 @@ and newlines.
 
 
 
+
   <div id="instance_attr_details" class="attr_details">
     <h2>Instance Attribute Details</h2>
 
@@ -362,6 +368,8 @@ and newlines.
 
 
 
+
+
 </h3><div class="docstring">
   <div class="discussion">
     Returns the value of attribute attr1
@@ -370,6 +378,7 @@ and newlines.
 </div>
 <div class="tags">
 
+
 </div><table class="source_code">
   <tr>
     <td>
@@ -400,6 +409,8 @@ end</pre>
 
 
 
+
+
 </h3><div class="docstring">
   <div class="discussion">
     Returns the value of attribute attr2
@@ -408,6 +419,7 @@ end</pre>
 </div>
 <div class="tags">
 
+
 </div><table class="source_code">
   <tr>
     <td>
@@ -442,6 +454,8 @@ end</pre>
 
 
 
+
+
 </h3><div class="docstring">
   <div class="discussion">
 
@@ -458,12 +472,13 @@ end</pre>
         <span class="signature">- (<tt>String</tt>) <strong>attr3</strong> </span>
         <div class="docstring">
   <div class="discussion">
-    A string
+    Returns a string
 
   </div>
 </div>
 <div class="tags">
-  <p class="tag_title">Returns:</p>
+
+<p class="tag_title">Returns:</p>
 <ul class="return">
 
     <li>
@@ -512,11 +527,13 @@ end</pre>
 
 </ul>
 
+
 </div>
       </li>
 
   </ul>
 
+
 </div><table class="source_code">
   <tr>
     <td>
@@ -547,6 +564,8 @@ end</pre>
 
 
 
+
+
 </h3><div class="docstring">
   <div class="discussion">
     Sets the attribute attr4
@@ -573,6 +592,7 @@ end</pre>
 
 </ul>
 
+
 </div><table class="source_code">
   <tr>
     <td>
@@ -608,6 +628,8 @@ end</pre>
 
 
 
+
+
 </h3><table class="source_code">
   <tr>
     <td>
@@ -642,6 +664,8 @@ def self.a; end</pre>
     <span class="names"><span id='b-instance_method'>b</span></span>
     </span>
 
+
+
 </h3><table class="source_code">
   <tr>
     <td>
@@ -670,6 +694,8 @@ def a; end</pre>
 
 
 
+
+
 </h3><div class="docstring">
   <div class="discussion">
 
@@ -678,6 +704,7 @@ def a; end</pre>
 </div>
 <div class="tags">
 
+
 </div><table class="source_code">
   <tr>
     <td>
@@ -702,6 +729,8 @@ def test_multi_overload(*args) end</pre>
 
 
 
+
+
 </h3><div class="docstring">
   <div class="discussion">
 
@@ -736,8 +765,10 @@ def test_multi_overload(*args) end</pre>
 
 </ul>
 
+
 </div>
 
+
 </div><table class="source_code">
   <tr>
     <td>
@@ -762,6 +793,8 @@ def test_overload(*args) end</pre>
 
 
 
+
+
 </h3><div class="docstring">
   <div class="discussion">
     <p class="note returns_void">This method returns an undefined value.</p>
@@ -770,6 +803,7 @@ def test_overload(*args) end</pre>
 </div>
 <div class="tags">
 
+
 </div><table class="source_code">
   <tr>
     <td>

data/templates/default/docstring/setup.rb

@@ -42,7 +42,9 @@ def docstring_text
   end
 
   if text.strip.empty? && object.tags(:return).size == 1 && object.tag(:return).text
-    text = object.tag(:return).text.gsub(/\A([a-z])/) {|x| x.upcase }
+    text = object.tag(:return).text.gsub(/\A([a-z])/) {|x| x.downcase }
+    text = "Returns #{text}" unless text.empty? || text =~ /^\s*return/i
+    text = text.gsub(/\A([a-z])/) {|x| x.upcase }
   end
 
   text.strip

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.8.6.2
+  version: 0.8.7
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-07-26 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.