yard 0.8.5.1 → 0.8.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf3ea6675e5ee7add306f00af42399d73f1c2999
-  data.tar.gz: 19dd59d2ba28a0e61274bd2421d044ae1a88f9c5
+  metadata.gz: 286e9bb0543c0d2d846d703abf038d42c0d08948
+  data.tar.gz: 1935aea9fce12ae0d560f0c2f4b65240aa688fac
 SHA512:
-  metadata.gz: be2aafaf48c04c81d39a40d4b644094772d38be3d57d50452dca692a19f5cdd1b4c0ce488e85ad9d1e49fa52b4a300449d9283765ed82ce39d75aff34dee62d6
-  data.tar.gz: 8263fee8b7c196c91e1c700042e120056418d4c23dc1c3da9b01435c9e47d40622ddc636213e4852db1d4545de99d4e951937c465e97c2a2108d316c3469abea
+  metadata.gz: 425fa8cdc965cd68b71230050e1d5c5741b9339218aeedfc4027b20ba2d15484ba1771c61b4bc0a6663b5c1b009d941644b6be323d9dd8e5a13314464bcd0a8e
+  data.tar.gz: 811d9eae07e7ded34d64e42858f2d9ddd2fad45847636c832f90f326a157fd0933000ce5168f9a6de97224084936c936e7adfbe8339ecdd6af75d9f09a0f5fdb

data/README.md

@@ -1,5 +1,4 @@
-YARD: Yay! A Ruby Documentation Tool
-====================================
+# YARD: Yay! A Ruby Documentation Tool
 
 **Homepage**:     [http://yardoc.org](http://yardoc.org)   
 **IRC**:          [irc.freenode.net / #yard](irc://irc.freenode.net/yard)    
@@ -8,11 +7,10 @@ YARD: Yay! A Ruby Documentation Tool
 **Contributors**: See Contributors section below    
 **Copyright**:    2007-2013    
 **License**:      MIT License    
-**Latest Version**: 0.8.5.1    
-**Release Date**: February 25th 2013    
+**Latest Version**: 0.8.5.2    
+**Release Date**: February 26th 2013    
 
-Synopsis
---------
+## Synopsis
 
 YARD is a documentation generation tool for the Ruby programming language.
 It enables the user to generate consistent, usable documentation that can be
@@ -21,8 +19,7 @@ custom Ruby constructs such as custom class level definitions. Below is a
 summary of some of YARD's notable features.
 
 
-Feature List
-------------
+## Feature List
 
 **1. RDoc/SimpleMarkup Formatting Compatibility**: YARD is made to be compatible
 with RDoc formatting. In fact, YARD does no processing on RDoc documentation
@@ -286,6 +283,9 @@ More options can be seen by typing `yard graph --help`, but here is an example:
 
 ## Changelog
 
+- **February.26.13**: 0.8.5.2 release
+    - Support new keyword argument syntax in method signatures (Ruby 2.x)
+
 - **February.25.13**: 0.8.5.1 release
     - Fix `yard diff` of gem files with RubyGems 2.x
 

data/lib/yard.rb

@@ -46,6 +46,9 @@ module YARD
 
   # @return [Boolean] whether YARD is being run in Ruby 1.9 mode
   def self.ruby19?; @ruby19 ||= (RUBY_VERSION >= "1.9.1") end
+
+  # @return [Boolean] whether YARD is being run in Ruby 2.0
+  def self.ruby2?; @ruby2 ||= (RUBY_VERSION >= '2.0.0') end
 end
 
 # Keep track of Ruby version for compatibility code

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

@@ -75,6 +75,7 @@ class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
     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
     params

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

@@ -381,12 +381,13 @@ module YARD
         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[-2] && self[-2][0] && self[-2][0].type == :default_arg
-            optional += self[-2]
+          optional = self[1] || []
+          if self[-3] && self[-3][0] && self[-3][0].type == :default_arg
+            optional += self[-3]
           end
-          optional
+          optional.empty? ? nil : optional
         end
+        def keyword_param; YARD.ruby2? ? self[-2] : nil end
       end
 
       class MethodCallNode < AstNode

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

@@ -14,7 +14,9 @@ module YARD
         end
 
         unless params.empty?
-          args = params.map {|n, v| v ? "#{n} = #{v}" : n.to_s }.join(", ")
+          args = params.map do |n, v|
+            v ? "#{n}#{n[-1,1] == ':' ? '' : ' ='} #{v}" : n.to_s
+          end.join(", ")
           h("(#{args})")
         else
           ""

data/lib/yard/version.rb

@@ -1,3 +1,3 @@
 module YARD
-  VERSION = "0.8.5.1"
+  VERSION = "0.8.5.2"
 end

data/spec/cli/diff_spec.rb

@@ -217,7 +217,6 @@ eof
     end
 
     it "should search for .gem file" do
-      iomock = mock(:io)
       File.should_receive(:directory?).with('gem1/.yardoc').and_return(false)
       File.should_receive(:directory?).with('gem2.gem/.yardoc').and_return(false)
       File.should_receive(:directory?).with('gem1').and_return(false)
@@ -226,16 +225,15 @@ eof
       File.should_receive(:exist?).with('gem1.gem').and_return(true)
       File.should_receive(:exist?).with('gem2.gem').and_return(true)
       File.should_receive(:exist?).any_number_of_times
-      File.should_receive(:open).with('gem1.gem', 'rb').and_yield(iomock)
+      File.should_receive(:open).with('gem1.gem', 'rb')
       File.should_receive(:open).with('gem2.gem', 'rb')
-      FileUtils.should_receive(:mkdir_p)
-      Gem::Package.should_receive(:open).with(iomock)
-      FileUtils.should_receive(:rm_rf)
+      FileUtils.stub(:mkdir_p)
+      Gem::Package.stub(:open)
+      FileUtils.stub(:rm_rf)
       @diff.run('gem1', 'gem2.gem')
     end
 
     it "should search for .gem file on rubygems.org" do
-      iomock = mock(:io)
       File.should_receive(:directory?).with('gem1/.yardoc').and_return(false)
       File.should_receive(:directory?).with('gem2.gem/.yardoc').and_return(false)
       File.should_receive(:directory?).with('gem1').and_return(false)
@@ -244,11 +242,11 @@ eof
       File.should_receive(:exist?).with('gem1.gem').and_return(false)
       File.should_receive(:exist?).with('gem2.gem').and_return(false)
       File.should_receive(:exist?).any_number_of_times
-      @diff.should_receive(:open).with('http://rubygems.org/downloads/gem1.gem').and_yield(iomock)
+      @diff.should_receive(:open).with('http://rubygems.org/downloads/gem1.gem')
       @diff.should_receive(:open).with('http://rubygems.org/downloads/gem2.gem')
-      FileUtils.should_receive(:mkdir_p)
-      Gem::Package.should_receive(:open).with(iomock)
-      FileUtils.should_receive(:rm_rf)
+      FileUtils.stub(:mkdir_p)
+      Gem::Package.stub(:open)
+      FileUtils.stub(:rm_rf)
       @diff.run('gem1', 'gem2.gem')
     end
 

data/spec/code_objects/extra_file_object_spec.rb

@@ -88,10 +88,13 @@ describe YARD::CodeObjects::ExtraFileObject do
 
     it "should attempt to re-parse data as 8bit ascii if parsing fails" do
       log.should_not_receive(:warn)
-      str = "\xB0"
-      str.force_encoding('utf-8') if str.respond_to?(:force_encoding)
+      str, out = *(["\xB0"] * 2)
+      if str.respond_to?(:force_encoding)
+        str.force_encoding('utf-8')
+        out.force_encoding('binary')
+      end
       file = ExtraFileObject.new('file.txt', str)
-      file.contents.should == "\xB0"
+      file.contents.should == out
     end
   end
 

data/spec/parser/source_parser_spec.rb

@@ -547,8 +547,13 @@ describe YARD::Parser::SourceParser do
           File.should_receive(:read_binary).with('tmpfile').and_return(src)
           result = parser.parse("tmpfile")
           if HAVE_RIPPER && YARD.ruby19?
-            ['Shift_JIS', 'Windows-31J', 'UTF-8'].send(msg, include(
-              result.enumerator[0].source.encoding.to_s))
+            if msg == :should_not
+              default_encoding = YARD.ruby2? ? 'UTF-8' : 'US-ASCII'
+              result.enumerator[0].source.encoding.to_s.should eq(default_encoding)
+            else
+              ['Shift_JIS', 'Windows-31J', 'UTF-8'].send(msg, include(
+                result.enumerator[0].source.encoding.to_s))
+            end
           end
           result.encoding_line.send(msg) == src.split("\n").last
         end
@@ -702,5 +707,11 @@ describe YARD::Parser::SourceParser do
       Registry.at('A#d').should be_nil
       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?
   end
 end

data/spec/templates/helpers/html_helper_spec.rb

@@ -115,8 +115,12 @@ describe YARD::Templates::Helpers::HtmlHelper do
 
     it "should handle various encodings" do
       stub!(:object).and_return(Registry.root)
-      Encoding.default_internal = 'utf-8' if defined?(Encoding)
-      htmlify("\xB0\xB1", :text)
+      text = "\xB0\xB1"
+      if defined?(Encoding)
+        Encoding.default_internal = 'utf-8'
+        text = text.force_encoding('binary')
+      end
+      htmlify(text, :text)
       # TODO: add more encoding tests
     end
 

data/spec/templates/helpers/method_helper_spec.rb

@@ -5,6 +5,13 @@ describe YARD::Templates::Helpers::MethodHelper do
   include YARD::Templates::Helpers::MethodHelper
 
   describe '#format_args' do
+    it "should display keyword arguments" do
+      params = [['a:', '1'], ['b:', '2'], ['**kwargs', nil]]
+      YARD.parse_string 'def foo; end'
+      Registry.at('#foo').stub(:parameters) { params }
+      format_args(Registry.at('#foo')).should == '(a: 1, b: 2, **kwargs)'
+    end
+
     it "should not show &blockarg if no @param tag and has @yield" do
       YARD.parse_string <<-'eof'
         # @yield blah

data/spec/templates/spec_helper.rb

@@ -26,6 +26,7 @@ end
 def html_equals_string(result, expected)
   [expected, result].each do |value|
     value.gsub!(/(>)\s+|\s+(<)/, '\1\2')
+    value.gsub!(/&#39;/, "'")
     value.strip!
   end
   text_equals_string(result, expected)

metadata

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