yard 0.9.18 → 0.9.23

data/spec/handlers/yield_handler_spec.rb

@@ -1,52 +1,52 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}YieldHandler" do
-  before(:all) { parse_file :yield_handler_001, __FILE__ }
-
-  it "only parses yield blocks in methods" do
-    expect(P(:Testing).tag(:yield)).to be nil
-    expect(P(:Testing).tag(:yieldparam)).to be nil
-  end
-
-  it "handles an empty yield statement" do
-    expect(P('Testing#mymethod').tag(:yield)).to be nil
-    expect(P('Testing#mymethod').tag(:yieldparam)).to be nil
-  end
-
-  it "does not document a yield statement in a method with either @yield or @yieldparam" do
-    expect(P('Testing#mymethod2').tag(:yield).types).to eq ['a', 'b']
-    expect(P('Testing#mymethod2').tag(:yield).text).to eq "Blah"
-    expect(P('Testing#mymethod2').tags(:yieldparam).size).to eq 2
-
-    expect(P('Testing#mymethod3').tag(:yield).types).to eq ['a', 'b']
-    expect(P('Testing#mymethod3').tags(:yieldparam).size).to eq 0
-
-    expect(P('Testing#mymethod4').tag(:yieldparam).name).to eq '_self'
-    expect(P('Testing#mymethod4').tag(:yieldparam).text).to eq 'BLAH'
-  end
-
-  it "handles any arbitrary yield statement" do
-    expect(P('Testing#mymethod5').tag(:yield).types).to eq [':a', 'b', '_self', 'File.read(\'file\', \'w\')', 'CONSTANT']
-  end
-
-  it "handles parentheses" do
-    expect(P('Testing#mymethod6').tag(:yield).types).to eq ['b', 'a']
-  end
-
-  it "only documents the first yield statement in a method (limitation of yield handler)" do
-    expect(P('Testing#mymethod7').tag(:yield).types).to eq ['a']
-  end
-
-  it "handles `self` keyword and list object type as yieldparam for _self" do
-    expect(P('Testing#mymethod8').tag(:yield).types).to eq ['_self']
-    expect(P('Testing#mymethod8').tag(:yieldparam).types).to eq ['Testing']
-    expect(P('Testing#mymethod8').tag(:yieldparam).text).to eq "the object that the method was called on"
-  end
-
-  it "handles `super` keyword and document it under _super" do
-    expect(P('Testing#mymethod9').tag(:yield).types).to eq ['_super']
-    expect(P('Testing#mymethod9').tag(:yieldparam).types).to be nil
-    expect(P('Testing#mymethod9').tag(:yieldparam).text).to eq "the result of the method from the superclass"
-  end
-end
+# frozen_string_literal: true
+require File.dirname(__FILE__) + '/spec_helper'
+
+RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}YieldHandler" do
+  before(:all) { parse_file :yield_handler_001, __FILE__ }
+
+  it "only parses yield blocks in methods" do
+    expect(P(:Testing).tag(:yield)).to be nil
+    expect(P(:Testing).tag(:yieldparam)).to be nil
+  end
+
+  it "handles an empty yield statement" do
+    expect(P('Testing#mymethod').tag(:yield)).to be nil
+    expect(P('Testing#mymethod').tag(:yieldparam)).to be nil
+  end
+
+  it "does not document a yield statement in a method with either @yield or @yieldparam" do
+    expect(P('Testing#mymethod2').tag(:yield).types).to eq ['a', 'b']
+    expect(P('Testing#mymethod2').tag(:yield).text).to eq "Blah"
+    expect(P('Testing#mymethod2').tags(:yieldparam).size).to eq 2
+
+    expect(P('Testing#mymethod3').tag(:yield).types).to eq ['a', 'b']
+    expect(P('Testing#mymethod3').tags(:yieldparam).size).to eq 0
+
+    expect(P('Testing#mymethod4').tag(:yieldparam).name).to eq '_self'
+    expect(P('Testing#mymethod4').tag(:yieldparam).text).to eq 'BLAH'
+  end
+
+  it "handles any arbitrary yield statement" do
+    expect(P('Testing#mymethod5').tag(:yield).types).to eq [':a', 'b', '_self', 'File.read(\'file\', \'w\')', 'CONSTANT']
+  end
+
+  it "handles parentheses" do
+    expect(P('Testing#mymethod6').tag(:yield).types).to eq ['b', 'a']
+  end
+
+  it "only documents the first yield statement in a method (limitation of yield handler)" do
+    expect(P('Testing#mymethod7').tag(:yield).types).to eq ['a']
+  end
+
+  it "handles `self` keyword and list object type as yieldparam for _self" do
+    expect(P('Testing#mymethod8').tag(:yield).types).to eq ['_self']
+    expect(P('Testing#mymethod8').tag(:yieldparam).types).to eq ['Testing']
+    expect(P('Testing#mymethod8').tag(:yieldparam).text).to eq "the object that the method was called on"
+  end
+
+  it "handles `super` keyword and document it under _super" do
+    expect(P('Testing#mymethod9').tag(:yield).types).to eq ['_super']
+    expect(P('Testing#mymethod9').tag(:yieldparam).types).to be nil
+    expect(P('Testing#mymethod9').tag(:yieldparam).text).to eq "the result of the method from the superclass"
+  end
+end

data/spec/i18n/locale_spec.rb

@@ -1,81 +1,81 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::I18n::Locale do
-  def locale(name)
-    YARD::I18n::Locale.new(name)
-  end
-
-  before do
-    @locale = locale("fr")
-  end
-
-  describe "#name" do
-    it "returns name" do
-      expect(locale("fr").name).to eq "fr"
-    end
-  end
-
-  describe "#load" do
-    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
-    if RUBY_VERSION < "1.9"
-      begin
-        require "gettext/tools/poparser"
-      rescue LoadError
-        have_gettext_gem = false
-      end
-    else
-      begin
-        require "gettext/po_parser"
-      rescue LoadError
-        begin
-          require "gettext/tools/poparser"
-        rescue LoadError
-          have_gettext_gem = false
-        end
-      end
-    end
-
-    it "returns true for existent PO", :if => have_gettext_gem do
-      data = <<-eop
-msgid ""
-msgstr ""
-"Language: fr\n"
-"MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-"Content-Transfer-Encoding: 8bit\n"
-
-msgid "Hello"
-msgstr "Bonjour"
-eop
-      parser = GetText::POParser.new
-      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(String.new(data), hash)
-      end
-      expect(@locale.load('foo')).to be true
-      expect(@locale.translate('Hello')).to eq "Bonjour"
-    end
-  end
-
-  describe "#translate" do
-    before do
-      messages = @locale.instance_variable_get(:@messages)
-      messages["Hello"] = "Bonjour"
-    end
-
-    it "returns translated string for existent string" do
-      expect(@locale.translate("Hello")) == "Bonjour"
-    end
-
-    it "returns original string for nonexistent string" do
-      expect(@locale.translate("nonexistent")) == "nonexistent"
-    end
-  end
-end
+# frozen_string_literal: true
+
+RSpec.describe YARD::I18n::Locale do
+  def locale(name)
+    YARD::I18n::Locale.new(name)
+  end
+
+  before do
+    @locale = locale("fr")
+  end
+
+  describe "#name" do
+    it "returns name" do
+      expect(locale("fr").name).to eq "fr"
+    end
+  end
+
+  describe "#load" do
+    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
+    if RUBY_VERSION < "1.9"
+      begin
+        require "gettext/tools/poparser"
+      rescue LoadError
+        have_gettext_gem = false
+      end
+    else
+      begin
+        require "gettext/po_parser"
+      rescue LoadError
+        begin
+          require "gettext/tools/poparser"
+        rescue LoadError
+          have_gettext_gem = false
+        end
+      end
+    end
+
+    it "returns true for existent PO", :if => have_gettext_gem do
+      data = <<-eop
+msgid ""
+msgstr ""
+"Language: fr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+msgid "Hello"
+msgstr "Bonjour"
+eop
+      parser = GetText::POParser.new
+      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(String.new(data), hash)
+      end
+      expect(@locale.load('foo')).to be true
+      expect(@locale.translate('Hello')).to eq "Bonjour"
+    end
+  end
+
+  describe "#translate" do
+    before do
+      messages = @locale.instance_variable_get(:@messages)
+      messages["Hello"] = "Bonjour"
+    end
+
+    it "returns translated string for existent string" do
+      expect(@locale.translate("Hello")) == "Bonjour"
+    end
+
+    it "returns original string for nonexistent string" do
+      expect(@locale.translate("nonexistent")) == "nonexistent"
+    end
+  end
+end

data/spec/i18n/message_spec.rb

@@ -1,52 +1,52 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::I18n::Message do
-  def message(id)
-    YARD::I18n::Message.new(id)
-  end
-
-  before do
-    @message = message("Hello World!")
-  end
-
-  describe "#id" do
-    it "returns ID" do
-      expect(message("Hello World!").id).to eq "Hello World!"
-    end
-  end
-
-  describe "#add_location" do
-    it "adds some locations" do
-      @message.add_location("hello.rb", 10)
-      @message.add_location("message.rb", 5)
-      expect(@message.locations).to eq Set.new([["hello.rb", 10], ["message.rb", 5]])
-    end
-  end
-
-  describe "#add_comment" do
-    it "adds some comments" do
-      @message.add_comment("YARD.title")
-      @message.add_comment("Hello#message")
-      expect(@message.comments).to eq Set.new(["YARD.title", "Hello#message"])
-    end
-  end
-
-  describe "#==" do
-    it "returns true for same value messages" do
-      locations = [["hello.rb", 10], ["message.rb", 5]]
-      comments = ["YARD.title", "Hello#message"]
-
-      other_message = message(@message.id)
-      locations.each do |path, line|
-        @message.add_location(path, line)
-        other_message.add_location(path, line)
-      end
-      comments.each do |comment|
-        @message.add_comment(comment)
-        other_message.add_comment(comment)
-      end
-
-      expect(@message).to eq other_message
-    end
-  end
-end
+# frozen_string_literal: true
+
+RSpec.describe YARD::I18n::Message do
+  def message(id)
+    YARD::I18n::Message.new(id)
+  end
+
+  before do
+    @message = message("Hello World!")
+  end
+
+  describe "#id" do
+    it "returns ID" do
+      expect(message("Hello World!").id).to eq "Hello World!"
+    end
+  end
+
+  describe "#add_location" do
+    it "adds some locations" do
+      @message.add_location("hello.rb", 10)
+      @message.add_location("message.rb", 5)
+      expect(@message.locations).to eq Set.new([["hello.rb", 10], ["message.rb", 5]])
+    end
+  end
+
+  describe "#add_comment" do
+    it "adds some comments" do
+      @message.add_comment("YARD.title")
+      @message.add_comment("Hello#message")
+      expect(@message.comments).to eq Set.new(["YARD.title", "Hello#message"])
+    end
+  end
+
+  describe "#==" do
+    it "returns true for same value messages" do
+      locations = [["hello.rb", 10], ["message.rb", 5]]
+      comments = ["YARD.title", "Hello#message"]
+
+      other_message = message(@message.id)
+      locations.each do |path, line|
+        @message.add_location(path, line)
+        other_message.add_location(path, line)
+      end
+      comments.each do |comment|
+        @message.add_comment(comment)
+        other_message.add_comment(comment)
+      end
+
+      expect(@message).to eq other_message
+    end
+  end
+end

data/spec/i18n/messages_spec.rb

@@ -1,67 +1,67 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::I18n::Messages do
-  def message(id)
-    YARD::I18n::Message.new(id)
-  end
-
-  def messages
-    YARD::I18n::Messages.new
-  end
-
-  before do
-    @messages = messages
-  end
-
-  describe "#each" do
-    it "enumerates messages" do
-      @messages.register("Hello World!")
-      @messages.register("Title")
-      enumerated_messages = []
-      @messages.each do |message|
-        enumerated_messages << message
-      end
-      enumerated_messages = enumerated_messages.sort_by(&:id)
-      expect(enumerated_messages).to eq [message("Hello World!"), message("Title")]
-    end
-
-    it "does not yield any message if there are none" do
-      enumerated_messages = []
-      @messages.each do |message|
-        enumerated_messages << message
-      end
-      expect(enumerated_messages).to eq []
-    end
-  end
-
-  describe "#[]" do
-    it "returns registered message" do
-      @messages.register("Hello World!")
-      expect(@messages["Hello World!"]).to eq message("Hello World!")
-    end
-
-    it "returns nil for nonexistent message ID" do
-      expect(@messages["Hello World!"]).to eq nil
-    end
-  end
-
-  describe "#register" do
-    it "returns registered message" do
-      expect(@messages.register("Hello World!")).to eq message("Hello World!")
-    end
-
-    it "returns existent message" do
-      message = @messages.register("Hello World!")
-      expect(@messages.register("Hello World!").object_id).to eq message.object_id
-    end
-  end
-
-  describe "#==" do
-    it "returns true for same value messages" do
-      @messages.register("Hello World!")
-      other_messages = messages
-      other_messages.register("Hello World!")
-      expect(@messages).to eq other_messages
-    end
-  end
-end
+# frozen_string_literal: true
+
+RSpec.describe YARD::I18n::Messages do
+  def message(id)
+    YARD::I18n::Message.new(id)
+  end
+
+  def messages
+    YARD::I18n::Messages.new
+  end
+
+  before do
+    @messages = messages
+  end
+
+  describe "#each" do
+    it "enumerates messages" do
+      @messages.register("Hello World!")
+      @messages.register("Title")
+      enumerated_messages = []
+      @messages.each do |message|
+        enumerated_messages << message
+      end
+      enumerated_messages = enumerated_messages.sort_by(&:id)
+      expect(enumerated_messages).to eq [message("Hello World!"), message("Title")]
+    end
+
+    it "does not yield any message if there are none" do
+      enumerated_messages = []
+      @messages.each do |message|
+        enumerated_messages << message
+      end
+      expect(enumerated_messages).to eq []
+    end
+  end
+
+  describe "#[]" do
+    it "returns registered message" do
+      @messages.register("Hello World!")
+      expect(@messages["Hello World!"]).to eq message("Hello World!")
+    end
+
+    it "returns nil for nonexistent message ID" do
+      expect(@messages["Hello World!"]).to eq nil
+    end
+  end
+
+  describe "#register" do
+    it "returns registered message" do
+      expect(@messages.register("Hello World!")).to eq message("Hello World!")
+    end
+
+    it "returns existent message" do
+      message = @messages.register("Hello World!")
+      expect(@messages.register("Hello World!").object_id).to eq message.object_id
+    end
+  end
+
+  describe "#==" do
+    it "returns true for same value messages" do
+      @messages.register("Hello World!")
+      other_messages = messages
+      other_messages.register("Hello World!")
+      expect(@messages).to eq other_messages
+    end
+  end
+end