yard 0.8.7.6 → 0.9.0

data/spec/i18n/locale_spec.rb

@@ -10,15 +10,15 @@ describe YARD::I18n::Locale do
   end
 
   describe "#name" do
-    it "should return name" do
-      locale("fr").name.should == "fr"
+    it "returns name" do
+      expect(locale("fr").name).to eq "fr"
     end
   end
 
   describe "#load" do
-    it "should return false for nonexistent PO" do
-      File.should_receive(:exist?).with('foo/fr.po').and_return(false)
-      @locale.load('foo').should == false
+    it "returns false for nonexistent PO" do
+      expect(File).to receive(:exist?).with('foo/fr.po').and_return(false)
+      expect(@locale.load('foo')).to be false
     end
 
     have_gettext_gem = true
@@ -40,7 +40,7 @@ describe YARD::I18n::Locale do
       end
     end
 
-    it "should return true for existent PO", :if => have_gettext_gem do
+    it "returns true for existent PO", :if => have_gettext_gem do
       data = <<-eop
 msgid ""
 msgstr ""
@@ -53,14 +53,14 @@ msgid "Hello"
 msgstr "Bonjour"
 eop
       parser = GetText::POParser.new
-      File.should_receive(:exist?).with('foo/fr.po').and_return(true)
-      GetText::POParser.should_receive(:new).and_return(parser)
-      parser.should_receive(:parse_file) do |file, hash|
-        file.should == 'foo/fr.po'
+      expect(File).to receive(:exist?).with('foo/fr.po').and_return(true)
+      expect(GetText::POParser).to receive(:new).and_return(parser)
+      expect(parser).to receive(:parse_file) do |file, hash|
+        expect(file).to eq 'foo/fr.po'
         parser.parse(data, hash)
       end
-      @locale.load('foo').should == true
-      @locale.translate('Hello').should == "Bonjour"
+      expect(@locale.load('foo')).to be true
+      expect(@locale.translate('Hello')).to eq "Bonjour"
     end
   end
 
@@ -70,12 +70,12 @@ eop
       messages["Hello"] = "Bonjour"
     end
 
-    it "should return translated string for existent string" do
-      @locale.translate("Hello") == "Bonjour"
+    it "returns translated string for existent string" do
+      expect(@locale.translate("Hello")) == "Bonjour"
     end
 
-    it "should return original string for nonexistent string" do
-      @locale.translate("nonexistent") == "nonexistent"
+    it "returns original string for nonexistent string" do
+      expect(@locale.translate("nonexistent")) == "nonexistent"
     end
   end
 end

data/spec/i18n/message_spec.rb

@@ -10,29 +10,29 @@ describe YARD::I18n::Message do
   end
 
   describe "#id" do
-    it "should return ID" do
-      message("Hello World!").id.should == "Hello World!"
+    it "returns ID" do
+      expect(message("Hello World!").id).to eq "Hello World!"
     end
   end
 
   describe "#add_location" do
-    it "should add some locations" do
+    it "adds some locations" do
       @message.add_location("hello.rb", 10)
       @message.add_location("message.rb", 5)
-      @message.locations.should == Set.new([["hello.rb", 10], ["message.rb", 5]])
+      expect(@message.locations).to eq Set.new([["hello.rb", 10], ["message.rb", 5]])
     end
   end
 
   describe "#add_comment" do
-    it "should add some comments" do
+    it "adds some comments" do
       @message.add_comment("YARD.title")
       @message.add_comment("Hello#message")
-      @message.comments.should == Set.new(["YARD.title", "Hello#message"])
+      expect(@message.comments).to eq Set.new(["YARD.title", "Hello#message"])
     end
   end
 
   describe "#==" do
-    it "should return true for same value messages" do
+    it "returns true for same value messages" do
       locations = [["hello.rb", 10], ["message.rb", 5]]
       comments = ["YARD.title", "Hello#message"]
 
@@ -46,7 +46,7 @@ describe YARD::I18n::Message do
         other_message.add_comment(comment)
       end
 
-      @message.should == other_message
+      expect(@message).to eq other_message
     end
   end
 end

data/spec/i18n/messages_spec.rb

@@ -14,7 +14,7 @@ describe YARD::I18n::Messages do
   end
 
   describe "#each" do
-    it "should enumerate Message" do
+    it "enumerates messages" do
       @messages.register("Hello World!")
       @messages.register("Title")
       enumerated_messages = []
@@ -22,46 +22,46 @@ describe YARD::I18n::Messages do
         enumerated_messages << message
       end
       enumerated_messages = enumerated_messages.sort_by {|m| m.id }
-      enumerated_messages.should == [message("Hello World!"), message("Title")]
+      expect(enumerated_messages).to eq [message("Hello World!"), message("Title")]
     end
 
-    it "should not any Message for empty messages" do
+    it "does not yield any message if there are none" do
       enumerated_messages = []
       @messages.each do |message|
         enumerated_messages << message
       end
-      enumerated_messages.should == []
+      expect(enumerated_messages).to eq []
     end
   end
 
   describe "#[]" do
-    it "should return registered message" do
+    it "returns registered message" do
       @messages.register("Hello World!")
-      @messages["Hello World!"].should == message("Hello World!")
+      expect(@messages["Hello World!"]).to eq message("Hello World!")
     end
 
-    it "should return for nonexistent message ID" do
-      @messages["Hello World!"].should == nil
+    it "returns nil for nonexistent message ID" do
+      expect(@messages["Hello World!"]).to eq nil
     end
   end
 
   describe "#register" do
-    it "should return registered message" do
-      @messages.register("Hello World!").should == message("Hello World!")
+    it "returns registered message" do
+      expect(@messages.register("Hello World!")).to eq message("Hello World!")
     end
 
-    it "should return existent message" do
+    it "returns existent message" do
       message = @messages.register("Hello World!")
-      @messages.register("Hello World!").object_id.should == message.object_id
+      expect(@messages.register("Hello World!").object_id).to eq message.object_id
     end
   end
 
   describe "#==" do
-    it "should return true for same value messages" do
+    it "returns true for same value messages" do
       @messages.register("Hello World!")
       other_messages = messages
       other_messages.register("Hello World!")
-      @messages.should == other_messages
+      expect(@messages).to eq other_messages
     end
   end
 end

data/spec/i18n/pot_generator_spec.rb

@@ -24,11 +24,11 @@ describe YARD::I18n::PotGenerator do
   end
 
   describe "Generate" do
-    it "should generate the default header" do
+    it "generates the default header" do
       current_time = Time.parse("2011-11-20 22:17+0900")
-      @generator.stub!(:current_time).and_return(current_time)
+      allow(@generator).to receive(:current_time).and_return(current_time)
       pot_creation_date = current_time.strftime("%Y-%m-%d %H:%M%z")
-      @generator.generate.should == <<-eoh
+      expect(@generator.generate).to eq <<-eoh
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
@@ -51,8 +51,8 @@ msgstr ""
 eoh
     end
 
-    it "should generate messages in location order" do
-      @generator.stub!(:header).and_return("HEADER\n\n")
+    it "generates messages in location order" do
+      allow(@generator).to receive(:header).and_return("HEADER\n\n")
       messages = {
         "tag|see|Parser::SourceParser.parse" => {
           :locations => [["yard.rb", 14]],
@@ -64,7 +64,7 @@ eoh
         }
       }
       add_messages(@generator.messages, messages)
-      @generator.generate.should == <<-'eoh'
+      expect(@generator.generate).to eq <<-'eoh'
 HEADER
 
 # YARD.parse
@@ -91,24 +91,24 @@ eoh
       pot
     end
 
-    it "should escape <\\>" do
-      generate_message_pot("hello \\ world").should == <<-'eop'
+    it "escapes <\\>" do
+      expect(generate_message_pot("hello \\ world")).to eq <<-'eop'
 msgid "hello \\ world"
 msgstr ""
 
 eop
     end
 
-    it "should escape <\">" do
-      generate_message_pot("hello \" world").should == <<-'eop'
+    it "escapes <\">" do
+      expect(generate_message_pot("hello \" world")).to eq <<-'eop'
 msgid "hello \" world"
 msgstr ""
 
 eop
     end
 
-    it "should escape <\\n>" do
-      generate_message_pot("hello \n world").should == <<-'eop'
+    it "escapes <\\n>" do
+      expect(generate_message_pot("hello \n world")).to eq <<-'eop'
 msgid "hello \n"
 " world"
 msgstr ""
@@ -123,12 +123,12 @@ eop
       @yard = YARD::CodeObjects::ModuleObject.new(:root, :YARD)
     end
 
-    it "should extract docstring" do
+    it "extracts at docstring" do
       object = YARD::CodeObjects::MethodObject.new(@yard, :parse, :module) do |o|
         o.docstring = "An alias to {Parser::SourceParser}'s parsing method"
       end
       @generator.parse_objects([object])
-      @generator.messages.should == create_messages({
+      expect(@generator.messages).to eq create_messages({
         "An alias to {Parser::SourceParser}'s parsing method" => {
           :locations => [],
           :comments => ["YARD.parse"],
@@ -136,13 +136,13 @@ eop
       })
     end
 
-    it "should extract location" do
+    it "extracts at location" do
       object = YARD::CodeObjects::MethodObject.new(@yard, :parse, :module) do |o|
         o.docstring = "An alias to {Parser::SourceParser}'s parsing method"
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      @generator.messages.should == create_messages({
+      expect(@generator.messages).to eq create_messages({
         "An alias to {Parser::SourceParser}'s parsing method" => {
           :locations => [["yard.rb", 13]],
           :comments => ["YARD.parse"],
@@ -150,13 +150,13 @@ eop
       })
     end
 
-    it "should extract tag name" do
+    it "extracts at tag name" do
       object = YARD::CodeObjects::MethodObject.new(@yard, :parse, :module) do |o|
         o.docstring = "@see Parser::SourceParser.parse"
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      @generator.messages.should == create_messages({
+      expect(@generator.messages).to eq create_messages({
         "tag|see|Parser::SourceParser.parse" => {
           :locations => [["yard.rb", 12]],
           :comments => ["@see"],
@@ -164,7 +164,7 @@ eop
       })
     end
 
-    it "should extract tag text" do
+    it "extracts at tag text" do
       object = YARD::CodeObjects::MethodObject.new(@yard, :parse, :module) do |o|
         o.docstring = <<-eod
 @example Parse a glob of files
@@ -173,7 +173,7 @@ eod
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      @generator.messages.should == create_messages({
+      expect(@generator.messages).to eq create_messages({
         "tag|example|Parse a glob of files" => {
           :locations => [["yard.rb", 12]],
           :comments => ["@example"],
@@ -185,7 +185,7 @@ eod
       })
     end
 
-    it "should extract tag types" do
+    it "extracts at tag types" do
       object = YARD::CodeObjects::MethodObject.new(@yard, :parse, :module) do |o|
         o.docstring = <<-eod
 @param [String, Array<String>] paths a path, glob, or list of paths to
@@ -194,7 +194,7 @@ eod
         o.files = [["yard.rb", 12]]
       end
       @generator.parse_objects([object])
-      @generator.messages.should == create_messages({
+      expect(@generator.messages).to eq create_messages({
         "tag|param|paths" => {
           :locations => [["yard.rb", 12]],
           :comments => ["@param [String, Array<String>]"],
@@ -206,7 +206,7 @@ eod
       })
     end
 
-    it "should extract overload tag recursively" do
+    it "extracts at overload tag recursively" do
       object = YARD::CodeObjects::MethodObject.new(@yard, :parse, :module) do |o|
         o.docstring = <<-eod
 @overload foo(i)
@@ -216,7 +216,7 @@ eod
       end
 
       @generator.parse_objects([object])
-      @generator.messages.should == create_messages({
+      expect(@generator.messages).to eq create_messages({
         "tag|overload|foo" => {
           :locations => [],
           :comments => ["@overload"]
@@ -238,18 +238,18 @@ eod
   end
 
   describe "File" do
-    it "should extract attribute" do
+    it "extracts at attribute" do
       path = "GettingStarted.md"
       text = <<-eor
 # @title Getting Started Guide
 
 # Getting Started with YARD
 eor
-      File.stub!(:open).with(path).and_yield(StringIO.new(text))
-      File.stub!(:read).with(path).and_return(text)
+      allow(File).to receive(:open).with(path).and_yield(StringIO.new(text))
+      allow(File).to receive(:read).with(path).and_return(text)
       file = YARD::CodeObjects::ExtraFileObject.new(path)
       @generator.parse_files([file])
-      @generator.messages.should == create_messages({
+      expect(@generator.messages).to eq create_messages({
         "Getting Started Guide" => {
           :locations => [[path, 1]],
           :comments => ["title"],
@@ -261,7 +261,7 @@ eor
       })
     end
 
-    it "should extract paragraphs" do
+    it "extracts at paragraphs" do
       path = "README.md"
       paragraph1 = <<-eop.strip
 Note that class methods must not be referred to with the "::" namespace
@@ -276,11 +276,11 @@ eop
 
 #{paragraph2}
 eot
-      File.stub!(:open).with(path).and_yield(StringIO.new(text))
-      File.stub!(:read).with(path).and_return(text)
+      allow(File).to receive(:open).with(path).and_yield(StringIO.new(text))
+      allow(File).to receive(:read).with(path).and_return(text)
       file = YARD::CodeObjects::ExtraFileObject.new(path)
       @generator.parse_files([file])
-      @generator.messages.should == create_messages({
+      expect(@generator.messages).to eq create_messages({
         paragraph1 => {
           :locations => [[path, 1]],
           :comments => [],

data/spec/i18n/text_spec.rb

@@ -12,45 +12,45 @@ describe YARD::I18n::Text do
     end
 
     describe "Header" do
-      it "should extract attribute" do
+      it "extracts at attribute" do
         text = <<-eot
 # @title Getting Started Guide
 
 # Getting Started with YARD
 eot
-        extract_messages(text, :have_header => true).should ==
+        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 "should ignore markup line" do
+      it "ignores markup line" do
         text = <<-eot
 #!markdown
 # @title Getting Started Guide
 
 # Getting Started with YARD
 eot
-        extract_messages(text, :have_header => true).should ==
+        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 "should terminate header block by markup line not at the first line" do
+      it "terminates header block by markup line not at the first line" do
         text = <<-eot
 # @title Getting Started Guide
 #!markdown
 
 # Getting Started with YARD
 eot
-        extract_messages(text, :have_header => true).should ==
+        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
 
     describe "Body" do
-      it "should split to paragraphs" do
+      it "splits to paragraphs" do
         paragraph1 = <<-eop.strip
 Note that class methods must not be referred to with the "::" namespace
 separator. Only modules, classes and constants should use "::".
@@ -64,9 +64,9 @@ eop
 
 #{paragraph2}
 eot
-        extract_messages(text).should ==
+        expect(extract_messages(text)).to eq(
           [[:paragraph, paragraph1, 1],
-           [:paragraph, paragraph2, 4]]
+           [:paragraph, paragraph2, 4]])
       end
     end
   end
@@ -88,7 +88,7 @@ eot
     end
 
     describe "Header" do
-      it "should extract attribute" do
+      it "extracts at attribute" do
         text = <<-eot
 # @title Hello
 
@@ -96,7 +96,7 @@ eot
 
 Paragraph.
 eot
-        translate(text, :have_header => true).should == <<-eot
+        expect(translate(text, :have_header => true)).to eq <<-eot
 # @title Bonjour (Hello in fr)
 
 # Getting Started with YARD
@@ -105,7 +105,7 @@ Paragraph.
 eot
       end
 
-      it "should ignore markup line" do
+      it "ignores markup line" do
         text = <<-eot
 #!markdown
 # @title Hello
@@ -114,7 +114,7 @@ eot
 
 Paragraph.
 eot
-        translate(text, :have_header => true).should == <<-eot
+        expect(translate(text, :have_header => true)).to eq <<-eot
 #!markdown
 # @title Bonjour (Hello in fr)
 
@@ -126,7 +126,7 @@ eot
     end
 
     describe "Body" do
-      it "should split to paragraphs" do
+      it "splits to paragraphs" do
         paragraph1 = <<-eop.strip
 Paragraph 1.
 eop
@@ -138,26 +138,26 @@ eop
 
 #{paragraph2}
 eot
-        translate(text).should == <<-eot
+        expect(translate(text)).to eq <<-eot
 Paragraphe 1.
 
 Paragraphe 2.
 eot
       end
 
-      it "should not modified non-translated message" do
+      it "does not modify non-translated message" do
         nonexistent_paragraph = <<-eop.strip
 Nonexsitent paragraph.
 eop
         text = <<-eot
 #{nonexistent_paragraph}
 eot
-        translate(text).should == <<-eot
+        expect(translate(text)).to eq <<-eot
 #{nonexistent_paragraph}
 eot
       end
 
-      it "should keep empty lines" do
+      it "keeps empty lines" do
         text = <<-eot
 Paragraph 1.
 
@@ -166,7 +166,7 @@ Paragraph 1.
 
 Paragraph 2.
 eot
-        translate(text).should == <<-eot
+        expect(translate(text)).to eq <<-eot
 Paragraphe 1.