yard 0.9.16 → 0.9.17

data/spec/verifier_spec.rb

@@ -1,106 +1,106 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::Verifier do
-  describe "#parse_expressions" do
-    it "creates #__execute method" do
-      v = Verifier.new("expr1")
-      expect(v).to respond_to(:__execute)
-    end
-
-    it "parses @tagname into tag('tagname')" do
-      obj = double(:object)
-      expect(obj).to receive(:tag).with('return')
-      Verifier.new('@return').call(obj)
-    end
-
-    it "parses @@tagname into object.tags('tagname')" do
-      obj = double(:object)
-      expect(obj).to receive(:tags).with('return')
-      Verifier.new('@@return').call(obj)
-    end
-
-    it "allows namespaced tag using @{} syntax" do
-      obj = double(:object)
-      expect(obj).to receive(:tag).with('yard.return')
-      Verifier.new('@{yard.return}').call(obj)
-    end
-
-    it "allows namespaced tags using @{} syntax" do
-      obj = double(:object)
-      expect(obj).to receive(:tags).with('yard.return')
-      Verifier.new('@@{yard.return}').call(obj)
-    end
-
-    it "calls methods on tag object" do
-      obj = double(:object)
-      obj2 = double(:tag)
-      expect(obj).to receive(:tag).with('return').and_return obj2
-      expect(obj2).to receive(:foo)
-      Verifier.new('@return.foo').call(obj)
-    end
-
-    it "sends any missing methods to object" do
-      obj = double(:object)
-      expect(obj).to receive(:has_tag?).with('return')
-      Verifier.new('has_tag?("return")').call(obj)
-    end
-
-    it "allows multiple expressions" do
-      obj = double(:object)
-      expect(obj).to receive(:tag).with('return').and_return(true)
-      expect(obj).to receive(:tag).with('param').and_return(false)
-      expect(Verifier.new('@return', '@param').call(obj)).to be false
-    end
-  end
-
-  describe "#o" do
-    it "aliases object to o" do
-      obj = double(:object)
-      expect(obj).to receive(:a).ordered
-      Verifier.new('o.a').call(obj)
-    end
-  end
-
-  describe "#call" do
-    it "doubles a nonexistent tag so that exceptions are not raised" do
-      obj = double(:object)
-      expect(obj).to receive(:tag).and_return(nil)
-      expect(Verifier.new('@return.text').call(obj)).to be false
-    end
-
-    it "does not fail if no expressions were added" do
-      expect { Verifier.new.call(nil) }.not_to raise_error
-    end
-
-    it "always ignores proxy objects and return true" do
-      v = Verifier.new('tag(:x)')
-      expect { expect(v.call(P('foo'))).to be true }.not_to raise_error
-    end
-  end
-
-  describe "#expressions" do
-    it "maintains a list of all unparsed expressions" do
-      expect(Verifier.new('@return.text', '@private').expressions).to eq ['@return.text', '@private']
-    end
-  end
-
-  describe "#expressions=" do
-    it "recompiles expressions when attribute is modified" do
-      obj = double(:object)
-      expect(obj).to receive(:tag).with('return')
-      v = Verifier.new
-      v.expressions = ['@return']
-      v.call(obj)
-    end
-  end
-
-  describe "#add_expressions" do
-    it "adds new expressions and recompile" do
-      obj = double(:object)
-      expect(obj).to receive(:tag).with('return')
-      v = Verifier.new
-      v.add_expressions '@return'
-      v.call(obj)
-    end
-  end
-end
+# frozen_string_literal: true
+
+RSpec.describe YARD::Verifier do
+  describe "#parse_expressions" do
+    it "creates #__execute method" do
+      v = Verifier.new("expr1")
+      expect(v).to respond_to(:__execute)
+    end
+
+    it "parses @tagname into tag('tagname')" do
+      obj = double(:object)
+      expect(obj).to receive(:tag).with('return')
+      Verifier.new('@return').call(obj)
+    end
+
+    it "parses @@tagname into object.tags('tagname')" do
+      obj = double(:object)
+      expect(obj).to receive(:tags).with('return')
+      Verifier.new('@@return').call(obj)
+    end
+
+    it "allows namespaced tag using @{} syntax" do
+      obj = double(:object)
+      expect(obj).to receive(:tag).with('yard.return')
+      Verifier.new('@{yard.return}').call(obj)
+    end
+
+    it "allows namespaced tags using @{} syntax" do
+      obj = double(:object)
+      expect(obj).to receive(:tags).with('yard.return')
+      Verifier.new('@@{yard.return}').call(obj)
+    end
+
+    it "calls methods on tag object" do
+      obj = double(:object)
+      obj2 = double(:tag)
+      expect(obj).to receive(:tag).with('return').and_return obj2
+      expect(obj2).to receive(:foo)
+      Verifier.new('@return.foo').call(obj)
+    end
+
+    it "sends any missing methods to object" do
+      obj = double(:object)
+      expect(obj).to receive(:has_tag?).with('return')
+      Verifier.new('has_tag?("return")').call(obj)
+    end
+
+    it "allows multiple expressions" do
+      obj = double(:object)
+      expect(obj).to receive(:tag).with('return').and_return(true)
+      expect(obj).to receive(:tag).with('param').and_return(false)
+      expect(Verifier.new('@return', '@param').call(obj)).to be false
+    end
+  end
+
+  describe "#o" do
+    it "aliases object to o" do
+      obj = double(:object)
+      expect(obj).to receive(:a).ordered
+      Verifier.new('o.a').call(obj)
+    end
+  end
+
+  describe "#call" do
+    it "doubles a nonexistent tag so that exceptions are not raised" do
+      obj = double(:object)
+      expect(obj).to receive(:tag).and_return(nil)
+      expect(Verifier.new('@return.text').call(obj)).to be false
+    end
+
+    it "does not fail if no expressions were added" do
+      expect { Verifier.new.call(nil) }.not_to raise_error
+    end
+
+    it "always ignores proxy objects and return true" do
+      v = Verifier.new('tag(:x)')
+      expect { expect(v.call(P('foo'))).to be true }.not_to raise_error
+    end
+  end
+
+  describe "#expressions" do
+    it "maintains a list of all unparsed expressions" do
+      expect(Verifier.new('@return.text', '@private').expressions).to eq ['@return.text', '@private']
+    end
+  end
+
+  describe "#expressions=" do
+    it "recompiles expressions when attribute is modified" do
+      obj = double(:object)
+      expect(obj).to receive(:tag).with('return')
+      v = Verifier.new
+      v.expressions = ['@return']
+      v.call(obj)
+    end
+  end
+
+  describe "#add_expressions" do
+    it "adds new expressions and recompile" do
+      obj = double(:object)
+      expect(obj).to receive(:tag).with('return')
+      v = Verifier.new
+      v.add_expressions '@return'
+      v.call(obj)
+    end
+  end
+end

data/templates/default/class/dot/setup.rb

@@ -1,7 +1,7 @@
-# frozen_string_literal: true
-include T('default/module/dot')
-
-def init
-  super
-  sections.push :superklass
-end
+# frozen_string_literal: true
+include T('default/module/dot')
+
+def init
+  super
+  sections.push :superklass
+end

data/templates/default/class/dot/superklass.erb

@@ -1,3 +1,3 @@
-<% if object.superclass.path != "Object" && object.superclass.path != "BasicObject" %>
-  <%= format_path object %> -> <%= format_path object.superclass %>;
+<% if object.superclass.path != "Object" && object.superclass.path != "BasicObject" %>
+  <%= format_path object %> -> <%= format_path object.superclass %>;
 <% end %>

data/templates/default/class/html/constructor_details.erb

@@ -1,8 +1,8 @@
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-  <% if @ctor.namespace != object %>
-    <p class="notice">This class inherits a constructor from <%= linkify @ctor, @ctor.namespace.path %></p>
-  <% else %>
-    <%= yieldall :object => @ctor, :index => 0 %>
-  <% end %>
-</div>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  <% if @ctor.namespace != object %>
+    <p class="notice">This class inherits a constructor from <%= linkify @ctor, @ctor.namespace.path %></p>
+  <% else %>
+    <%= yieldall :object => @ctor, :index => 0 %>
+  <% end %>
+</div>

data/templates/default/class/html/setup.rb

@@ -1,2 +1,2 @@
-# frozen_string_literal: true
-include T('default/module/html')
+# frozen_string_literal: true
+include T('default/module/html')

data/templates/default/class/html/subclasses.erb

@@ -1,4 +1,4 @@
-<div id="subclasses">
-  <h2>Direct Known Subclasses</h2>
-  <p class="children"><%= @subclasses.map {|name, child| linkify(child, name) }.join(", ") %></p>
-</div>
+<div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><%= @subclasses.map {|name, child| linkify(child, name) }.join(", ") %></p>
+</div>

data/templates/default/class/setup.rb

@@ -1,36 +1,36 @@
-# frozen_string_literal: true
-include T('default/module')
-
-def init
-  super
-  sections.place(:subclasses).before(:children)
-  sections.place(:constructor_details, [T('method_details')]).before(:methodmissing)
-end
-
-def constructor_details
-  ctors = object.meths(:inherited => true, :included => true)
-  @ctor = ctors.find(&:constructor?)
-  return unless @ctor
-  return if prune_method_listing([@ctor]).empty?
-  erb(:constructor_details)
-end
-
-def subclasses
-  return if object.path == "Object" # don't show subclasses for Object
-  unless globals.subclasses
-    globals.subclasses = {}
-    list = run_verifier Registry.all(:class)
-    list.each do |o|
-      (globals.subclasses[o.superclass.path] ||= []) << o if o.superclass
-    end
-  end
-
-  @subclasses = globals.subclasses[object.path]
-  return if @subclasses.nil? || @subclasses.empty?
-  @subclasses = @subclasses.sort_by(&:path).map do |child|
-    name = child.path
-    name = object.relative_path(child) if object.namespace
-    [name, child]
-  end
-  erb(:subclasses)
-end
+# frozen_string_literal: true
+include T('default/module')
+
+def init
+  super
+  sections.place(:subclasses).before(:children)
+  sections.place(:constructor_details, [T('method_details')]).before(:methodmissing)
+end
+
+def constructor_details
+  ctors = object.meths(:inherited => true, :included => true)
+  @ctor = ctors.find(&:constructor?)
+  return unless @ctor
+  return if prune_method_listing([@ctor]).empty?
+  erb(:constructor_details)
+end
+
+def subclasses
+  return if object.path == "Object" # don't show subclasses for Object
+  unless globals.subclasses
+    globals.subclasses = {}
+    list = run_verifier Registry.all(:class)
+    list.each do |o|
+      (globals.subclasses[o.superclass.path] ||= []) << o if o.superclass
+    end
+  end
+
+  @subclasses = globals.subclasses[object.path]
+  return if @subclasses.nil? || @subclasses.empty?
+  @subclasses = @subclasses.sort_by(&:path).map do |child|
+    name = child.path
+    name = object.relative_path(child) if object.namespace
+    [name, child]
+  end
+  erb(:subclasses)
+end

data/templates/default/class/text/setup.rb

@@ -1,12 +1,12 @@
-# frozen_string_literal: true
-include T('default/module/text')
-
-def init
-  super
-  sections.place(:subclasses).before(:children)
-  sections.delete(:children)
-end
-
-def format_object_title(object)
-  "Class: #{object.title} < #{object.superclass.title}"
-end
+# frozen_string_literal: true
+include T('default/module/text')
+
+def init
+  super
+  sections.place(:subclasses).before(:children)
+  sections.delete(:children)
+end
+
+def format_object_title(object)
+  "Class: #{object.title} < #{object.superclass.title}"
+end

data/templates/default/class/text/subclasses.erb

@@ -1,5 +1,5 @@
-Direct Known Subclasses:
-------------------------
-
-<%= indent(wrap(@subclasses.map {|name, child| name }.join(", "))) %>
-
+Direct Known Subclasses:
+------------------------
+
+<%= indent(wrap(@subclasses.map {|name, child| name }.join(", "))) %>
+

data/templates/default/constant/text/header.erb

@@ -1,11 +1,11 @@
-<%= title_align_right format_object_title(object) %>
-
-
-<%= object.name %> = <%= object.value.size > 40 ? "\n\n" + indent(object.value) : object.value %>
-
-
-<%= hr %>
-
-<%= yieldall %>
-
-<%= hr %>
+<%= title_align_right format_object_title(object) %>
+
+
+<%= object.name %> = <%= object.value.size > 40 ? "\n\n" + indent(object.value) : object.value %>
+
+
+<%= hr %>
+
+<%= yieldall %>
+
+<%= hr %>

data/templates/default/constant/text/setup.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: true
-def init
-  sections :header, [T('docstring')]
-end
+# frozen_string_literal: true
+def init
+  sections :header, [T('docstring')]
+end

data/templates/default/docstring/html/abstract.erb

@@ -1,4 +1,4 @@
-<div class="note abstract">
-  <strong>This <%= object.type %> is abstract.</strong>
-  <%= htmlify_line object.tag(:abstract).text %>
-</div>
+<div class="note abstract">
+  <strong>This <%= object.type %> is abstract.</strong>
+  <%= htmlify_line object.tag(:abstract).text %>
+</div>

data/templates/default/docstring/html/deprecated.erb

@@ -1 +1 @@
-<div class="note deprecated"><strong>Deprecated.</strong> <%= htmlify_line object.tag(:deprecated).text %></div>
+<div class="note deprecated"><strong>Deprecated.</strong> <%= htmlify_line object.tag(:deprecated).text %></div>

data/templates/default/docstring/html/index.erb

@@ -1,5 +1,5 @@
-<div class="docstring">
-  <div class="discussion">
-    <%= yieldall %>
-  </div>
-</div>
+<div class="docstring">
+  <div class="discussion">
+    <%= yieldall %>
+  </div>
+</div>

data/templates/default/docstring/html/note.erb

@@ -1,6 +1,6 @@
-<% object.tags(:note).each do |tag| %>
-  <div class="note notetag">
-    <strong>Note:</strong>
-    <%= htmlify_line tag.text %>
-  </div>
-<% end %>
+<% object.tags(:note).each do |tag| %>
+  <div class="note notetag">
+    <strong>Note:</strong>
+    <%= htmlify_line tag.text %>
+  </div>
+<% end %>