yard 0.9.5 → 0.9.6

data/spec/i18n/text_spec.rb

@@ -1,8 +1,8 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+# frozen_string_literal: true
 
-describe YARD::I18n::Text do
+RSpec.describe YARD::I18n::Text do
   describe "#extract_messages" do
-    def extract_messages(input, options={})
+    def extract_messages(input, options = {})
       text = YARD::I18n::Text.new(StringIO.new(input), options)
       messages = []
       text.extract_messages do |*message|
@@ -20,7 +20,8 @@ describe YARD::I18n::Text do
 eot
         expect(extract_messages(text, :have_header => true)).to eq(
           [[:attribute, "title", "Getting Started Guide", 1],
-           [:paragraph, "# Getting Started with YARD", 3]])
+           [:paragraph, "# Getting Started with YARD", 3]]
+        )
       end
 
       it "ignores markup line" do
@@ -32,7 +33,8 @@ eot
 eot
         expect(extract_messages(text, :have_header => true)).to eq(
           [[:attribute, "title", "Getting Started Guide", 2],
-           [:paragraph, "# Getting Started with YARD", 4]])
+           [:paragraph, "# Getting Started with YARD", 4]]
+        )
       end
 
       it "terminates header block by markup line not at the first line" do
@@ -45,7 +47,8 @@ eot
         expect(extract_messages(text, :have_header => true)).to eq(
           [[:attribute, "title", "Getting Started Guide", 1],
            [:paragraph, "#!markdown", 2],
-           [:paragraph, "# Getting Started with YARD", 4]])
+           [:paragraph, "# Getting Started with YARD", 4]]
+        )
       end
     end
 
@@ -66,7 +69,8 @@ eop
 eot
         expect(extract_messages(text)).to eq(
           [[:paragraph, paragraph1, 1],
-           [:paragraph, paragraph2, 4]])
+           [:paragraph, paragraph2, 4]]
+        )
       end
     end
   end
@@ -82,7 +86,7 @@ eot
       locale
     end
 
-    def translate(input, options={})
+    def translate(input, options = {})
       text = YARD::I18n::Text.new(StringIO.new(input), options)
       text.translate(locale)
     end
@@ -161,16 +165,16 @@ eot
         text = <<-eot
 Paragraph 1.
 
-  
-	
+
+
 
 Paragraph 2.
 eot
         expect(translate(text)).to eq <<-eot
 Paragraphe 1.
 
-  
-	
+
+
 
 Paragraphe 2.
 eot

data/spec/logging_spec.rb

@@ -1,6 +1,6 @@
-require File.join(File.dirname(__FILE__), "spec_helper")
+# frozen_string_literal: true
 
-describe YARD::Logger do
+RSpec.describe YARD::Logger do
   describe "#show_backtraces" do
     it "is true if debug level is on" do
       log.show_backtraces = true

data/spec/options_spec.rb

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/spec_helper'
+# frozen_string_literal: true
 
-describe YARD::Options do
+RSpec.describe YARD::Options do
   class FooOptions < YARD::Options
     attr_accessor :foo
     def initialize; self.foo = "abc" end
@@ -111,7 +111,7 @@ describe YARD::Options do
     it "does not ignore keys with no setter (OpenStruct behaviour)" do
       o = FooOptions.new
       o.update(:bar => "xyz")
-      expect(o.to_hash).to eq({:foo => "abc", :bar => "xyz"})
+      expect(o.to_hash).to eq(:foo => "abc", :bar => "xyz")
     end
   end
 
@@ -119,13 +119,13 @@ describe YARD::Options do
     it "updates a new object" do
       o = FooOptions.new
       expect(o.merge(:foo => "xyz").object_id).not_to eq o.object_id
-      expect(o.merge(:foo => "xyz").to_hash).to eq({:foo => "xyz"})
+      expect(o.merge(:foo => "xyz").to_hash).to eq(:foo => "xyz")
     end
 
     it "adds in values from original object" do
       o = FooOptions.new
       o.update(:bar => "foo")
-      expect(o.merge(:baz => 1).to_hash).to eq({:foo => "abc", :bar => "foo", :baz => 1})
+      expect(o.merge(:baz => 1).to_hash).to eq(:foo => "abc", :bar => "foo", :baz => 1)
     end
   end
 
@@ -149,7 +149,7 @@ describe YARD::Options do
         def foo; "HELLO#{@foo}" end
       end
       o = ToHashOptions2.new
-      expect(o.to_hash).to eq({:foo => "HELLO1"})
+      expect(o.to_hash).to eq(:foo => "HELLO1")
     end
 
     it "ignores ivars with no accessor" do
@@ -158,14 +158,14 @@ describe YARD::Options do
         def initialize; @foo = 1; @bar = "NOIGNORE" end
       end
       o = ToHashOptions3.new
-      expect(o.to_hash).to eq({:foo => 1, :bar => "NOIGNORE"})
+      expect(o.to_hash).to eq(:foo => 1, :bar => "NOIGNORE")
     end
   end
 
   describe "#tap" do
     it "supports #tap(&block) (even in 1.8.6)" do
-      o = FooOptions.new.tap {|o| o.foo = :BAR }
-      expect(o.to_hash).to eq({:foo => :BAR})
+      o = FooOptions.new.tap {|obj| obj.foo = :BAR }
+      expect(o.to_hash).to eq(:foo => :BAR)
     end
   end
 end

data/spec/parser/base_spec.rb

@@ -1,6 +1,6 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+# frozen_string_literal: true
 
-describe YARD::Parser::Base do
+RSpec.describe YARD::Parser::Base do
   describe "#initialize" do
     class MyParser < Parser::Base; def initialize(a, b) end end
 

data/spec/parser/c_parser_spec.rb

@@ -1,6 +1,6 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+# frozen_string_literal: true
 
-describe YARD::Parser::C::CParser do
+RSpec.describe YARD::Parser::C::CParser do
   describe "#parse" do
     def parse(contents)
       Registry.clear
@@ -68,7 +68,8 @@ describe YARD::Parser::C::CParser do
           }
         eof
         expect(Registry.at('Foo#foo').source.gsub(/\s\s+/, ' ')).to eq(
-          "VALUE foo(VALUE x) { int value = x;\n}")
+          "VALUE foo(VALUE x) { int value = x;\n}"
+        )
       end
     end
 
@@ -121,8 +122,8 @@ describe YARD::Parser::C::CParser do
         end
         thr.join(5)
         if thr.alive?
-          fail "Did not parse in time"
           thr.kill
+          raise "Did not parse in time"
         end
       end
     end

data/spec/parser/ruby/ast_node_spec.rb

@@ -1,10 +1,10 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+# frozen_string_literal: true
 require 'pp'
 require 'stringio'
 
 include YARD::Parser::Ruby
 
-describe YARD::Parser::Ruby::AstNode do
+RSpec.describe YARD::Parser::Ruby::AstNode do
   describe "#jump" do
     it "jumps to the first specific inner node if found" do
       ast = s(:paren, s(:paren, s(:params, s(s(:ident, "hi"), s(:ident, "bye")))))
@@ -23,11 +23,11 @@ describe YARD::Parser::Ruby::AstNode do
       out = StringIO.new
       PP.pp(obj, out)
       vcall = RUBY_VERSION >= '1.9.3' ? 'vcall' : 'var_ref'
-      expect(out.string).to eq "s(s(:#{vcall},\n" +
-        "      s(:ident, \"bye\", line: 2..2, source: 4..6),\n" +
-        "      docstring: \"x\",\n" +
-        "      line: 2..2,\n" +
-        "      source: 4..6))\n"
+      expect(out.string).to eq "s(s(:#{vcall},\n" \
+                               "      s(:ident, \"bye\", line: 2..2, source: 4..6),\n" \
+                               "      docstring: \"x\",\n" \
+                               "      line: 2..2,\n" \
+                               "      source: 4..6))\n"
     end
   end
 end if HAVE_RIPPER

data/spec/parser/ruby/legacy/statement_list_spec.rb

@@ -1,6 +1,6 @@
-require File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper')
+# frozen_string_literal: true
 
-describe YARD::Parser::Ruby::Legacy::StatementList do
+RSpec.describe YARD::Parser::Ruby::Legacy::StatementList do
   def stmts(code) YARD::Parser::Ruby::Legacy::StatementList.new(code) end
   def stmt(code) stmts(code).first end
 
@@ -187,7 +187,7 @@ eof
       def method; end
     eof
     expect(s.comments).to eq ["comment", "comment", "comment"]
-    expect(s.comments_range).to eq (1..3)
+    expect(s.comments_range).to eq(1..3)
 
     s = stmt <<-eof
 
@@ -196,7 +196,7 @@ eof
       def method; end
     eof
     expect(s.comments).to eq ["comment", "comment"]
-    expect(s.comments_range).to eq (2..3)
+    expect(s.comments_range).to eq(2..3)
 
     s = stmt <<-eof
       # comment
@@ -205,20 +205,20 @@ eof
       def method; end
     eof
     expect(s.comments).to eq ["comment", "comment"]
-    expect(s.comments_range).to eq (1..2)
+    expect(s.comments_range).to eq(1..2)
 
     s = stmt <<-eof
       # comment
       def method; end
     eof
     expect(s.comments).to eq ["comment"]
-    expect(s.comments_range).to eq (1..1)
+    expect(s.comments_range).to eq(1..1)
 
     s = stmt <<-eof
       def method; end # comment
     eof
     expect(s.comments).to eq ["comment"]
-    expect(s.comments_range).to eq (1..1)
+    expect(s.comments_range).to eq(1..1)
   end
 
   it "only looks up to two lines back for comments" do

data/spec/parser/ruby/legacy/token_list_spec.rb

@@ -1,10 +1,10 @@
-require File.join(File.dirname(__FILE__), '..', '..', '..', 'spec_helper')
+# frozen_string_literal: true
 
 include YARD::Parser::Ruby::Legacy
 include YARD::Parser::Ruby::Legacy::RubyToken
 
-describe YARD::Parser::Ruby::Legacy::TokenList do
-  describe  "#initialize / #push" do
+RSpec.describe YARD::Parser::Ruby::Legacy::TokenList do
+  describe "#initialize / #push" do
     it "accepts a tokenlist (via constructor or push)" do
       expect { TokenList.new(TokenList.new) }.not_to raise_error
       expect(TokenList.new.push(TokenList.new("x = 2")).size).to eq 6
@@ -74,4 +74,4 @@ describe YARD::Parser::Ruby::Legacy::TokenList do
       expect(@t.to_s(true, false)).to eq "def x;  end"
     end
   end
-end
+end

data/spec/parser/ruby/ruby_parser_spec.rb

@@ -1,6 +1,6 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+# frozen_string_literal: true
 
-describe YARD::Parser::Ruby::RubyParser do
+RSpec.describe YARD::Parser::Ruby::RubyParser do
   def stmt(stmt)
     YARD::Parser::Ruby::RubyParser.new(stmt, nil).parse.root.first
   end
@@ -22,7 +22,7 @@ describe YARD::Parser::Ruby::RubyParser do
         def method; end
       eof
       expect(s.comments).to eq "comment\ncomment\ncomment"
-      expect(s.comments_range).to eq (1..3)
+      expect(s.comments_range).to eq(1..3)
 
       s = stmt <<-eof
 
@@ -31,7 +31,7 @@ describe YARD::Parser::Ruby::RubyParser do
         def method; end
       eof
       expect(s.comments).to eq "comment\ncomment"
-      expect(s.comments_range).to eq (2..3)
+      expect(s.comments_range).to eq(2..3)
 
       s = stmt <<-eof
         # comment
@@ -40,20 +40,20 @@ describe YARD::Parser::Ruby::RubyParser do
         def method; end
       eof
       expect(s.comments).to eq "comment\ncomment"
-      expect(s.comments_range).to eq (1..2)
+      expect(s.comments_range).to eq(1..2)
 
       s = stmt <<-eof
         # comment
         def method; end
       eof
       expect(s.comments).to eq "comment"
-      expect(s.comments_range).to eq (1..1)
+      expect(s.comments_range).to eq(1..1)
 
       s = stmt <<-eof
         def method; end # comment
       eof
       expect(s.comments).to eq "comment"
-      expect(s.comments_range).to eq (1..1)
+      expect(s.comments_range).to eq(1..1)
     end
 
     it "only looks up to two lines back for comments" do
@@ -175,7 +175,7 @@ eof
     it "handles defs with keywords as method name" do
       ast = stmt("# docstring\nclass A;\ndef class; end\nend")
       expect(ast.jump(:class).docstring).to eq "docstring"
-      expect(ast.jump(:class).line_range).to eq (2..4)
+      expect(ast.jump(:class).line_range).to eq(2..4)
     end
 
     it "handles defs with unnamed argument with default values" do
@@ -239,7 +239,7 @@ eof
       s = stmt(src)
       t = tokenize(src)
       expect(s.source).to eq src
-      expect(t.map { |x| x[1] }.join).to eq src
+      expect(t.map {|x| x[1] }.join).to eq src
     end
 
     it "shows proper source for regular heredoc" do
@@ -247,7 +247,7 @@ eof
       s = stmt(src)
       t = tokenize(src)
       expect(s.source).to eq src
-      expect(t.map { |x| x[1] }.join).to eq src
+      expect(t.map {|x| x[1] }.join).to eq src
     end
 
     it "shows proper source for heredoc with comment" do
@@ -270,14 +270,32 @@ eof
       expect(stmt(src).jump(:string_literal).source).to eq '"this is a string"'
     end
 
-    it "shows proper source for %w() array" do
-      src = "%w(\na b c\n d e f\n)"
-      expect(stmt(src).jump(:qwords_literal).source).to eq src
+    %w(w W i I).each do |tok|
+      it "shows proper source for %#{tok}() array" do
+        src = "%#{tok}(\na b c\n d e f\n)"
+        expect(stmt(src).source).to eq src
+      end
+
+      it "shows proper source for %#{tok}{} array" do
+        src = "%#{tok}{\na b c\n d e f\n}"
+        expect(stmt(src).source).to eq src
+      end
     end
 
-    it "shows proper source for %w{} array" do
-      src = "%w{\na b c\n d e f\n}"
-      expect(stmt(src).jump(:array).source).to eq src
+    {'i' => :qsymbols_literal, 'I' => :symbols_literal,
+     'w' => :qwords_literal, 'W' => :words_literal}.each do |id, sym|
+      it "parses %#{id}(...) literals" do
+        [
+          "TEST = %#{id}(A B C)",
+          "TEST = %#{id}(  A  B  C  )",
+          "TEST = %#{id}( \nA \nB \nC \n)",
+          "TEST = %#{id}(\n\nAD\n\nB\n\nC\n\n)",
+          "TEST = %#{id}(\n A\n B\n C\n )"
+        ].each do |str|
+          node = stmt(str).jump(sym)
+          expect(node.source).to eq(str[/(\%#{id}\(.+\))/m, 1])
+        end
+      end
     end
 
     it "parses %w() array in constant declaration" do
@@ -335,7 +353,7 @@ eof
           # Ending comment
         end
       eof
-      expect(s.jump(:class).line_range).to eq (1..7)
+      expect(s.jump(:class).line_range).to eq(1..7)
     end
 
     it "has the correct line range for blocks" do
@@ -372,7 +390,7 @@ eof
 
     it "does not group comments if they don't begin the line" do
       Registry.clear
-      ast = YARD.parse_string(<<-eof).enumerator
+      YARD.parse_string(<<-eof).enumerator
         class Foo
           CONST1 = 1 # Comment here
           CONST2 = 2 # Another comment here
@@ -385,7 +403,7 @@ eof
     %w(if unless).each do |type|
       it "does not get confused by modifier '#{type}' statements" do
         Registry.clear
-        ast = YARD.parse_string(<<-eof).enumerator
+        YARD.parse_string(<<-eof).enumerator
           module Foo
             #{type} test?
               # Docstring
@@ -432,7 +450,7 @@ eof
 
       it "does not add comment blocks to #{type}_mod nodes" do
         Registry.clear
-        ast = YARD.parse_string(<<-eof).enumerator
+        YARD.parse_string(<<-eof).enumerator
           class Foo
             # Docstring
             def bar; end if true
@@ -450,5 +468,9 @@ eof
       expect(Registry.at(:Foo).docstring).to eq "this is a comment"
       expect(Registry.at(:Bar).docstring).to eq "this is a comment"
     end
+
+    it "handles compile errors" do
+      expect { stmt(":~$ Do not clobber") }.to raise_error(Parser::ParserSyntaxError)
+    end
   end
 end if HAVE_RIPPER